Skip to navigation
Referencia APISubscriptions

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.

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)

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

subscription_idstringOptional

ID de la suscripción

invoice_idstring or nullOptional

ID de la factura en la que se cobró (null mientras está pendiente)

created_atdatetimeOptional
updated_atdatetimeOptional

Errors

422
Unprocessable Entity Error