Skip to main content

Facturar a los clientes

Las aplicaciones de GitHub Marketplace deben cumplir las directrices de facturación de GitHub y dar soporte a los servicios recomendados. El seguir nuestros lineamientos ayuda a los clientes a navegar en el proceso de facturación sin ninguna sorpresa.

Nota:

Este artículo se aplica solo a la publicación de aplicaciones en GitHub Marketplace. Para obtener más información sobre la publicación de GitHub Actions en GitHub Marketplace, consulta Publicar acciones en GitHub Marketplace.

Entender el ciclo de facturación

Los clientes pueden escoger un ciclo mensual o anual cuando compran tu app. Todos los cambios que realicen los clientes en el ciclo de facturación y la selección del plan desencadenarán un evento marketplace_purchase. Puede consultar la carga del webhook marketplace_purchase para ver qué ciclo de facturación selecciona un cliente y cuándo comienza la siguiente fecha de facturación (effective_date). Para más información sobre las cargas útiles de webhooks, consulte Eventos de webhook de la API de GitHub Marketplace.

Proporcionar servicios de facturación en la IU de tu app

Los clientes deberán ser capaces de realizar las siguientes acciones desde el sitio web de tu app:

  • Los clientes deberían poder modificar o cancelar sus planes de GitHub Marketplace para sus cuentas personales y de organización por separado.
  • Los clientes que cancelan un plan de pago que se haya comprado en GitHub Marketplace deben degradar su versión automáticamente al plan gratuito de la app en caso de que éste exista. Se recomienda ampliamente la Cuando un cliente cancela una suscripción de GitHub Marketplace, GitHub no desinstala la app automáticamente, así que el cliente puede esperar que las características gratuitas sigan funcionando. para permitir a los usuarios el rehabilitar su plan previo.
  • Los clientes deben poder realizar la actualización de desde la interfaz de usuario de la aplicación si proporciona una dirección URL de actualización en este formato: https://www.github.com/marketplace/<LISTING_NAME>/upgrade/<LISTING_PLAN_NUMBER>/<CUSTOMER_ACCOUNT_ID>
  • Los clientes deben poder modificar qué usuarios tienen acceso a tu app desde el sitio web de la misma si compraron plazas (plan de precios por unidad) o si el plan ofrece colaboradores ilimitados.
  • Los clientes deben poder ver los siguientes cambios a su cuenta inmediatamente en la sección de facturación, perfil, o configuración de cuenta del sitio web de la app:
    • Plan y precios actuales.
    • Nuevos planes comprados.
    • Mejoras, degradaciones, cancelaciones y la cantidad de días restantes del periodo de prueba gratuito.
    • Cambios en los ciclos de facturación (mensual o anual).
    • Uso y recursos restantes para los planes por unidad y de tasa fija. Por ejemplo, si el plan de precios es por unidad, el sitio de tu app debería mostrar las unidades que se utilizan y las que quedan disponibles.

Servicios de facturación para mejoras, decrementos y cancelaciones

Sigue estos lineamientos para las mejoras, decrementos y cancelaciones para mantener un proceso de facturación limpio y consistente. Para más información sobre los eventos de compra de GitHub Marketplace, consulta Uso de la API de Marketplace de GitHub en la aplicación.

Puede usar la clave del marketplace_purchase webhook effective_date para determinar cuándo se producirá un cambio de plan y sincronizar periódicamente la lista de cuentas de un plan.

Actualizaciones

Cuando un cliente mejora su plan de precios o cambia su ciclo de facturación de mensual a anual, deberás hacerles el cambio efectivo inmediatamente. Tienes que aplicar un descuento prorrateado para el plan nuevo y cambiar el ciclo de facturación.

En caso de que un cliente mejore su plan y el pago falle, GitHub revertirá su suscripción de GitHub Marketplace a su estado previo. GitHub también enviará un correo electrónico al cliente para informarle de dicho fallo y para permitirles volver a intentar la compra. Recibirá un webhook con la acción changed en el que se solicita revertir al plan anterior.

Para obtener información sobre cómo integrar flujos de trabajo de actualización y retroceso en tu aplicación, consulta Gestionar cambios de plan.

Decrementos y cancelaciones

Los decrementos ocurren cuando un cliente se cambia de un plan pagado a uno gratuito, selecciona un plan con un costo menor al actual, o cambia su ciclo de facturación de anual a mensual. Cuando suceden los decrementos o cancelaciones, no necesitas proporcionar un reembolso. En vez de esto, el plan actual se mantendrá activo hasta el último día del ciclo de facturación actual. El evento marketplace_purchase se enviará cuando el nuevo plan surta efecto al principio del siguiente ciclo de facturación del cliente.

Cuando un cliente cancela un plan, debes:

  • Degradarlos automáticamente al plan gratuito, si es que existe.

    Cuando un cliente cancela una suscripción de GitHub Marketplace, GitHub no desinstala la app automáticamente, así que el cliente puede esperar que las características gratuitas sigan funcionando.

  • Habilite para actualizar el plan a través de GitHub si desea continuar con el plan más adelante.

Para información sobre cómo crear flujos de trabajo de cancelación en la aplicación, consulta Gestionar las cancelaciones de plan.