Skip to main content
Su ID pay_ también es el ID del pago cuando se cobra. Usa la API de facturas para crear y editar borradores, y luego emitirlos o enviarlos. Puedes cobrar una factura abierta a un método de pago guardado o anular una factura que el comprador no vaya a pagar. La creación de un borrador no concede acceso ni cobra al comprador. Los datos de contacto del destinatario se encuentran en el miembro de la cuenta. Los campos financieros y los metadatos del llamante solo se pueden editar en borrador.

Endpoints

Atributos

string
requerido
string
requerido
object
requerido

Propiedades

string
requerido
El importe en unidades principales, como cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún número de coma flotante lo redondee durante la transmisión.
string
requerido
Código de moneda ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
integer
requerido
Cuántos decimales MOSTRAR. Normalmente igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, así que es 2 y 0. Usa esto para formatear el número en tu propia configuración regional.
object | null
requerido

Propiedades

string | null
requerido
La ciudad.
string | null
requerido
El código de país ISO 3166-1 alfa-2.
string | null
requerido
La primera línea de la dirección postal.
string | null
requerido
La segunda línea de la dirección postal.
string | null
requerido
El nombre que figura en la dirección.
string | null
requerido
El código postal.
string | null
requerido
El estado, provincia o región.
object
requerido

Propiedades

string
requerido
El importe en unidades principales, como cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún número de coma flotante lo redondee durante la transmisión.
string
requerido
Código de moneda ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
integer
requerido
Cuántos decimales MOSTRAR. Normalmente igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, así que es 2 y 0. Usa esto para formatear el número en tu propia configuración regional.
number
requerido
Un enlace firmado que abre esta factura en una sesión de checkout para que el comprador pueda pagarla. Pásalo como link a POST /checkout_sessions. Presente mientras la factura está abierta. null en cualquier otro estado, para una factura emitida a un comprador empresarial y para una factura cuya membresía se canceló. También es null a menos que tengas payment:charge, o invoice:create o invoice:update en una factura sin payment_method_id.
string
requerido
string | null
requerido
boolean
requerido
True cuando DELETE /invoices/\{id} puede eliminar esta factura. Un borrador cumple los requisitos salvo que esté programado o facture una suscripción. Una factura anulada cumple los requisitos salvo que haya cobrado dinero o siga esperando una transferencia bancaria.
string | null
requerido
string | null
requerido
string | null
requerido
object[]
requerido

Propiedades

string | null
requerido
ID de la partida, con el prefijo li_. Null cuando el pago es anterior a las instantáneas de artículos y el artículo se lee de la variante del pago.
string | null
requerido
Texto que se muestra debajo del artículo en la factura, su correo electrónico y su PDF, leído de la description de la variante. Un cargo personalizado lo establece con la description del artículo. Una variante de producto conserva la suya. Null cuando la variante no tiene ninguna o se ha eliminado desde entonces.
object | null
requerido
El descuento promocional aplicado a este artículo, en la currency del pago. Null cuando no se registró ningún descuento.

Propiedades

string
requerido
El importe en unidades principales, como cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún número de coma flotante lo redondee durante la transmisión.
string
requerido
Código de moneda ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
integer
requerido
Cuántos decimales MOSTRAR. Normalmente igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, así que es 2 y 0. Usa esto para formatear el número en tu propia configuración regional.
object | null
requerido
La parte de unit_amount que corresponde a la tarifa inicial única de una variante recurrente, el initial_price de la variante, cobrada solo en esta factura. El resto de unit_amount es el primer periodo de facturación. Una prueba no tiene cargo por el primer periodo. Null para artículos únicos, facturas de renovación, artículos sin tarifa inicial y artículos cuyos precios de variante cambiaron después de que se fijara el precio de la factura.

Propiedades

string
requerido
El importe en unidades principales, como cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún número de coma flotante lo redondee durante la transmisión.
string
requerido
Código de moneda ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
integer
requerido
Cuántos decimales MOSTRAR. Normalmente igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, así que es 2 y 0. Usa esto para formatear el número en tu propia configuración regional.
string | null
requerido
El nombre del artículo tal como se muestra en el checkout (el título del producto o, en su defecto, el título de la variante).
string | null
requerido
El producto al que pertenece la variante, con el prefijo prod_. Null para una variante sin producto.
number
requerido
Cuántas unidades se compraron.
object | null
requerido
unit_amount multiplicado por quantity, antes de descuentos e impuestos, en la currency del pago.

Propiedades

string
requerido
El importe en unidades principales, como cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún número de coma flotante lo redondee durante la transmisión.
string
requerido
Código de moneda ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
integer
requerido
Cuántos decimales MOSTRAR. Normalmente igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, así que es 2 y 0. Usa esto para formatear el número en tu propia configuración regional.
object | null
requerido
El impuesto cobrado sobre este artículo, en la currency del pago. Null cuando no se registró ningún impuesto.

Propiedades

string
requerido
El importe en unidades principales, como cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún número de coma flotante lo redondee durante la transmisión.
string
requerido
Código de moneda ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
integer
requerido
Cuántos decimales MOSTRAR. Normalmente igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, así que es 2 y 0. Usa esto para formatear el número en tu propia configuración regional.
integer | null
requerido
Días de prueba gratuita antes del primer cargo de renovación de este artículo recurrente, tomados del trial_period_days de la variante. La factura entonces cobra solo el initial_price de la variante para el artículo. null para artículos únicos y facturas de renovación, y cuando el cliente ya tenía una suscripción a la variante.
object | null
requerido
El precio guardado de una unidad antes de descuentos, en la currency del pago. Crear o reemplazar artículos recurrentes incluye la tarifa inicial, más el primer periodo de facturación salvo que el artículo empiece con una prueba. Las facturas de renovación excluyen la tarifa inicial. Otras ediciones conservan los precios guardados. Null cuando el pago no registró ningún precio.

Propiedades

string
requerido
El importe en unidades principales, como cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún número de coma flotante lo redondee durante la transmisión.
string
requerido
Código de moneda ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
integer
requerido
Cuántos decimales MOSTRAR. Normalmente igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, así que es 2 y 0. Usa esto para formatear el número en tu propia configuración regional.
string | null
requerido
La variante comprada, con el prefijo plan_. Null cuando la variante se ha eliminado desde entonces.
string | null
requerido
string | null
requerido
string | null
requerido
La membresía que factura esta factura, con el prefijo mem_. Para una factura de renovación, es la suscripción que se renueva. Para una factura con un artículo recurrente, es la membresía creada cuando se emite la factura. Null para facturas puntuales, para un borrador aún no emitido y sin el permiso member:basic:read.
string | null
requerido
Una nota para el cliente, que se muestra en el correo electrónico de la factura, el PDF y la página de checkout conservando sus saltos de línea. null cuando no se ha establecido ninguna.
object
requerido
string
requerido
string
requerido
boolean
requerido
string | null
requerido
object | null
requerido
Los métodos de pago entre los que el cliente puede elegir al pagar mediante el enlace de checkout de la factura. Tiene prioridad sobre las variantes de la factura y la cuenta. null cuando la factura usa los métodos de pago de sus variantes.

Propiedades

string[]
requerido
Métodos de pago que este checkout excluye, incluso cuando los valores predeterminados los ofrecerían.
string[]
requerido
Métodos de pago que este checkout ofrece además de los que proporcionan los valores predeterminados.
boolean
requerido
Si el conjunto predeterminado de Whop es el punto de partida. Cuando es false, solo se ofrece enabled.
string | null
requerido
string[]
requerido
Destinatarios del correo electrónico de la factura, independientes del cliente facturado.
string | null
requerido
Cuándo se cobrará el método de pago guardado de la factura, como marca de tiempo ISO 8601. Es el charge_at con el que se envió o emitió la factura. Sin él, es due_at cuando una factura con un payment_method_id se envía o emite antes de su vencimiento. En un borrador, es el charge_at de su envío programado. null en otros casos, una vez que comienza el cargo y una vez que la factura está pagada, anulada o es incobrable.
string | null
requerido
El collection_method que aplica el envío programado de un borrador cuando se ejecuta. null cuando el borrador no tiene envío programado o se programó sin uno, y una vez que se emite la factura.Opciones disponibles: charge_automatically, send_invoice
string | null
requerido
boolean
requerido
Si este borrador se emite automáticamente cuando llega su due_at. Emitirlo cobra su payment_method_id o envía por correo electrónico su enlace de pago a sus recipient_emails. false para una factura que no es un borrador y para un borrador con un envío programado. false mientras enviar el borrador fallaría por falta de destinatarios o por un enlace de pago no disponible. false para un borrador que no tenía un due_at futuro cuando se guardó por última vez. false para un borrador creado antes de 2026-11-12T22:00:00Z.
string
requerido
Opciones disponibles: draft, open, authorized, paid, pending, uncollectible, unresolved, void
string | null
requerido
Cuándo comienza el primer periodo de facturación de los artículos recurrentes de la factura, como marca de tiempo ISO 8601. Las renovaciones cuentan a partir de este momento. null inicia el periodo cuando se paga la factura, al igual que una hora que ya haya pasado para entonces. Una factura con fecha de inicio omite la prueba gratuita de sus variantes.
object
requerido

Propiedades

string
requerido
El importe en unidades principales, como cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún número de coma flotante lo redondee durante la transmisión.
string
requerido
Código de moneda ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
integer
requerido
Cuántos decimales MOSTRAR. Normalmente igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, así que es 2 y 0. Usa esto para formatear el número en tu propia configuración regional.
object | null
requerido

Propiedades

string
requerido
El importe en unidades principales, como cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún número de coma flotante lo redondee durante la transmisión.
string
requerido
Código de moneda ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
integer
requerido
Cuántos decimales MOSTRAR. Normalmente igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, así que es 2 y 0. Usa esto para formatear el número en tu propia configuración regional.
string
requerido
La zona horaria IANA para las fechas del correo electrónico y el PDF de la factura, como America/New_York. UTC salvo que se haya establecido una.
object
requerido

Propiedades

string
requerido
El importe en unidades principales, como cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún número de coma flotante lo redondee durante la transmisión.
string
requerido
Código de moneda ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
integer
requerido
Cuántos decimales MOSTRAR. Normalmente igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, así que es 2 y 0. Usa esto para formatear el número en tu propia configuración regional.
string
requerido
Opciones disponibles: estimated, final
string
requerido
Invoice