Skip to navigation

Cancelar un cobro único pendiente

Cancela un cobro único que sigue pendiente (aún no se ha aplicado a una factura). No se puede cancelar uno ya aplicado.

Envía Idempotency-Key para poder reintentar una cancelación si pierdes la respuesta. Durante 24 horas, repetir el mismo DELETE con la misma clave, ruta y cuerpo devuelve el 200 y el cuerpo originales, con Idempotency-Replayed: true, sin volver a cancelar ni registrar otra actividad.

Reutilizar la clave con otra ruta o cuerpo devuelve 409. Sin una respuesta exitosa guardada para esa clave, cancelar un cobro que ya no está pendiente devuelve 422 (también si ya está cancelado).

Authentication

X-SECRET-KEYstring

Tu clave secreta de API.

Una llave de cuenta (sk_live_..., sk_test_...) opera sobre su propia cuenta y, con X-ACCOUNT-ID, sobre sus cuentas conectadas.

La llave también fija el ambiente: una sk_test_ solo lista y resuelve objetos de prueba (live_mode: false) y una sk_live_ solo objetos reales. Un ID del otro ambiente responde 404 (401 en /customers).

Una llave de organización (sk_org_live_..., sk_org_test_...) alcanza todas las cuentas de una organización y solo sirve para leer: saldos, movimientos y reportes. Para operar sobre una cuenta debe nombrarla con X-ACCOUNT-ID; omitirlo en una lectura devuelve todas las cuentas de la organización. Cualquier otro endpoint responde 403 con code: organization_key_unsupported.

Path parameters

subscription_idstringRequired

ID de la suscripción

idstringRequired

ID del cobro único (ej. ii_ab12cd34)

Headers

X-ACCOUNT-IDstringOptional

ID de una cuenta hija conectada. Ejecuta el request dentro de esa cuenta, como Stripe-Account en Stripe Connect. La plataforma puede acceder a todos los recursos API que pertenecen a la hija, sin filtrar por creador. Solo aplica a hijas directas: si la cuenta no está conectada a la tuya, el request responde 404 con code: connected_account_not_found.

Con una llave de organización este header nombra la cuenta miembro sobre la que quieres operar; si no pertenece a la organización, el request responde 404 con code: organization_account_not_found. En una lectura puedes omitirlo para abarcar todas las cuentas de la organización.

Idempotency-KeystringOptional

Clave de idempotencia para reintentos seguros de operaciones críticas, especialmente las que mueven dinero o cambian estado operativo. Reintentar con la misma clave y el mismo cuerpo devuelve la respuesta original (header Idempotency-Replayed: true); reusarla con parámetros distintos devuelve 409.

Response headers

Idempotency-ReplayedenumOptional

Presente con valor true cuando se devuelve la respuesta guardada de una cancelación anterior.

Allowed values:

Response

Cobro único cancelado

objectenumOptional
Tipo estable del recurso
Allowed values:
idstringOptional

ID único del cobro

statusenumOptional

Estado: pending (en cola), applied (ya aplicado a una factura), cancelled.

Allowed values:
amount_in_centsintegerOptional

Monto en centavos. Positivo para un cargo, negativo para un crédito.

currencystringOptional

Moneda (coincide con la de la suscripción)

descriptionstringOptional

Descripción visible para el cliente

tax_categoryenumOptional

Clasificación fiscal con que se certifica el cobro en la FEL (service = Servicio, good = Bien): la enviada o, si se omitió, la del producto del ítem recurrente más antiguo activo de la suscripción (o del más antiguo si ninguno lo está). Si la suscripción se cancela con cobros pendientes, se cobran juntos en una sola línea por el total neto, que se certifica como Servicio solo si todos son service (los que no tienen clasificación cuentan como good); si no, como Bien. null solo en cobros creados antes de que existiera el campo, que se certifican como Bien.

Allowed values:
subscription_idstringOptional

ID de la suscripción

invoice_idstring or nullOptional

Identificador numérico de la factura a la que se aplicó el ítem, representado como string (null si aún no tiene factura).

created_atdatetimeOptional
updated_atdatetimeOptional

Errors

409
Conflict Error
422
Unprocessable Entity Error