Frecuentemente publicamos actualizaciones de nuestra documentación. Es posible que la traducción de esta página esté en curso. Para conocer la información más actual, visita la documentación en inglés. Si existe un problema con las traducciones en esta página, por favor infórmanos.

Eventos de webhook para la API de GitHub Marketplace

Una app de Mercado GitHub recibe información acerca de los cambios en el plan de un usuario desde el webhook del evento de compra en Marketplace. Un evento de compra de marketplace se activa cuando un usuario compra, cancela o cambia su plan de pago. Para encontrar más detalles sobre cómo responder a cada uno de estos tipos de eventos, consulta la sección "Flujos de facturación."

Carga útil del webhook de compras en Mercado GitHub

Las solicitudes de POST de los webhooks tienen encabezados especiales. Consulta la sección "Encabezados de entrega de Webhooks" para encontrar más detalles. GitHub no reenvía los intentos fallidos de entrega. Asegúrate de que tu app pueda recibir toda la carga útil del webhook que envíe GitHub.

Las cancelaciones y disminuciones de categoría toman efecto el primer día del siguiente ciclo de facturación. Los eventos para las cancelaciones y disminuciones de categoría se envían cuando el nuevo plan entre en vigor al inicio del siguiente ciclo de facturación. Los eventos para las nuevas compras y mejoras de categoría comienzan inmediatamente. Utiliza effective_date en la carga útil del webhook para determinar cuándo comenzará un cambio.

Nota: Si notas cualquier compra de Mercado GitHub que genera spam o que presenta cualquier otro comportamiento malicioso, por favor, completa el formato de reportar abuso con más información sobre el usuario.

Cada carga útil de webhook de una marketplace_purchase tendrá la siguiente información:

ClaveTipoDescripción
AcciónsecuenciaLa acción realizada para generar el webhook. Puede ser purchased, cancelled, pending_change, pending_change_cancelled, o changed. Para obtener más información, consulta los ejemplos de cargas útiles de webhook a continuación. Nota: las cargas útiles de pending_change y pending_change_cancelled contienen las mismas claves que se muestra en el ejemplo de carga útil de changed.
effective_datesecuenciaLa fecha en la que la action se hace efectiva.
senderobjetoLa persona que tomó la action que activó el webhook.
marketplace_purchaseobjetoLa información de compra de Mercado GitHub.

El objeto marketplace_purchase tiene las siguientes claves:

ClaveTipoDescripción
cuentaobjetoLa cuenta de organización o usuario asociada con la suscripción. Las cuentas de organización incluirán organization_billing_email, que es la dirección de correo electrónico administrativa de la misma. Para encontrar direcciones de correo electrónico para cuentas personales, puedes utilizar la terminal Obtener el usuario autenticado.
billing_cyclesecuenciaPuede ser yearly o monthly. Cuando el dueño de la account tiene un plan gratuito de GitHub y compra un plan gratuito de Mercado GitHub, el billing_cycle será nil.
unit_countnúmeroCantidad de unidades compradas.
on_free_trialbooleanEs true cuando la account está en un periodo de prueba gratuito.
free_trial_ends_onsecuenciaLa fecha en la que caduca el periodo de prueba gratuito.
next_billing_datesecuenciaLa fecha en la que comenzará el siguiente ciclo de facturación. Cuando el dueño de la account tiene un plan gratuito de GitHub.com y compra un plan gratuito de Mercado GitHub, el next_billing_date será nil.
planobjetoEl plan que compra el user u organization.

El objeto plan tiene las siguientes claves:

ClaveTipoDescripción
idnúmeroEl identificador único para este plan.
name (nombre)secuenciaEl nombre del plan.
descripciónsecuenciaLa descripción de este plan.
monthly_price_in_centsnúmeroEl precio mensual de este plan en centavos (Divisa de los EEUU). Por ejemplo, un listado que cuesta 10 dólares de EEUU por mes sería de 1000 centavos.
yearly_price_in_centsnúmeroEl precio anual para este plan en centavos (Divisa de los EEUU). Por ejemplo, un listado que cuesta 100 dólares de EEUU por mes sería de 10000 centavos.
price_modelsecuenciaEl modelo de precios para este listado. Puede ser alguno de entre flat-rate, per-unit, o free.
has_free_trialbooleanes true cuando este listado ofrece un periodo de prueba gratuito.
unit_namesecuenciaEl nombre de la unidad. Si el modelo de precios no es per-unit, éste será nil.
bulletconjunto de secuenciasLos nombres de los puntos configurados en el plan de precios.

Ejemplo de la carga útil de un webhook para un evento de purchased

Este ejemplo proporciona la carga útil del evento purchased.

Ejemplo de la carga útil de un webhook para un evento de changed

Los cambios en un plan incluyen mejoras y degradaciones. Este ejemplo representa las cargas útiles de los eventos changed,pending_change, y pending_change_cancelled. La acción identifica cuál de estos tres eventos ha ocurrido.

Ejemplo de carga útil del webhook para un evento de cancelled

¿Te ayudó este documento?

Privacy policy

Help us make these docs great!

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Make a contribution

O, learn how to contribute.