Saltar al contenido principal

kobana billing subscription-changes

Comandos de kobana billing subscription-changes. Toda opción global (Opciones globales) vale aquí.

ComandoHTTPDescripción
subscription-changes config listGET /v1/subscription_changes/configObtener configuración de cambios de suscripción
subscription-changes config updatePUT /v1/subscription_changes/configActualizar configuración de cambios de suscripción

subscription-changes config list​

Obtener configuración de cambios de suscripción

kobana billing subscription-changes config list [OPCIONES]

GET /v1/subscription_changes/config

Devuelve la configuración de la organización para cambios en ítems de suscripción — operaciones permitidas (agregar/eliminar/cambiar cantidad/cambiar precio), método de prorrateo por operación, momento de aplicación (immediate o end_of_period), reembolso/crédito al eliminar y self-service en el portal. Si aún no existe, se crea con los valores por defecto en la primera lectura.

Respuestas

HTTPDescripción
200Configuración de la organización.
404Recurso no encontrado en la organización actual.

subscription-changes config update​

Actualizar configuración de cambios de suscripción

kobana billing subscription-changes config update [OPCIONES]

PUT /v1/subscription_changes/config

Actualiza parcialmente la configuración. Solo se modifican los campos enviados. refund_on_remove requiere que credit_on_remove también esté habilitado — el reembolso es una variante del crédito.

Cuerpo de la solicitud

NombreTipoObligatorioDescripción
allow_item_addbooleannoPermite agregar nuevos ítems a una suscripción existente.
allow_item_removebooleannoPermite eliminar ítems de una suscripción existente.
allow_quantity_changebooleannoPermite cambiar la cantidad de ítems ya presentes en la suscripción.
allow_price_swapbooleannoPermite cambiar el precio (variante) de un ítem existente sin eliminarlo.
add_prorationstringnoMétodo de prorrateo al agregar ítems: full_proration, no_proration o partial_proration. Valores: full_proration, no_proration, partial_proration.
remove_prorationstringnoMétodo de prorrateo al eliminar ítems: full_proration, no_proration o partial_proration. Valores: full_proration, no_proration, partial_proration.
quantity_up_prorationstringnoMétodo de prorrateo al aumentar la cantidad de un ítem. Valores: full_proration, no_proration, partial_proration.
quantity_down_prorationstringnoMétodo de prorrateo al reducir la cantidad de un ítem. Valores: full_proration, no_proration, partial_proration.
add_timingstringnoMomento de aplicación al agregar ítems: immediate o end_of_period. Valores: immediate, end_of_period.
remove_timingstringnoMomento de aplicación al eliminar ítems: immediate o end_of_period. Valores: immediate, end_of_period.
quantity_up_timingstringnoMomento de aplicación al aumentar cantidad: immediate o end_of_period. Valores: immediate, end_of_period.
quantity_down_timingstringnoMomento de aplicación al reducir cantidad: immediate o end_of_period. Valores: immediate, end_of_period.
refund_on_removebooleannoCuando es true, emite un reembolso al cliente al eliminar ítems. Requiere credit_on_remove habilitado.
credit_on_removebooleannoCuando es true, emite un crédito a favor del cliente al eliminar ítems.
portal_self_servicebooleannoCuando es true, permite que el cliente cambie su propia suscripción desde el portal.
portal_require_confirmationbooleannoCuando es true, exige confirmación explícita del cliente antes de aplicar el cambio en el portal.
external_idstringnoIdentificador en su sistema externo, para idempotencia/sincronización.
custom_metadataobjectnoMetadatos arbitrarios definidos por el cliente (clave/valor).

Otros campos y objetos anidados: kobana schema billing.subscription-changes.config.update.

Respuestas

HTTPDescripción
200Configuración actualizada.
400El cuerpo de la solicitud falló en la validación.
404Recurso no encontrado en la organización actual.
422El cuerpo de la solicitud falló en la validación.