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
Propiedades
Propiedades
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.Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
Propiedades
Propiedades
Propiedades
Propiedades
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.Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
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.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.Propiedades
Propiedades
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.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.El descuento promocional aplicado a este artículo, en la
currency del pago. Null cuando no se registró ningún descuento.Propiedades
Propiedades
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.Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
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
Propiedades
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.Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
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).
El producto al que pertenece la variante, con el prefijo
prod_. Null para una variante sin producto.unit_amount multiplicado por quantity, antes de descuentos e impuestos, en la currency del pago.Propiedades
Propiedades
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.Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
El impuesto cobrado sobre este artículo, en la
currency del pago. Null cuando no se registró ningún impuesto.Propiedades
Propiedades
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.Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
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.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
Propiedades
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.Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
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.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.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
Propiedades
Métodos de pago que este checkout excluye, incluso cuando los valores predeterminados los ofrecerían.
Métodos de pago que este checkout ofrece además de los que proporcionan los valores predeterminados.
Destinatarios del correo electrónico de la factura, independientes del cliente facturado.
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.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_invoiceSi 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.Opciones disponibles:
draft, open, authorized, paid, pending, uncollectible, unresolved, voidCuá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.Propiedades
Propiedades
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.Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
Propiedades
Propiedades
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.Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
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.Propiedades
Propiedades
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.Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
Invoice

