Cancelar usuarios suscritos a plan

GET 
/plan/:plan_id/suscripcion/cancelar

Cancelar usuarios suscritos a plan

Request

Path Parameters

plan_id stringrequired

Identificador de Plan

Responses

200

Arreglo de objetos con suscripcion_id y cliente_id de las suscripciones canceladas

application/json

Schema

Schema

status string

Possible values: [success, fail, error]

Estatus de la petición

http_code integer

Possible values: [200, 400, 401, 404, 500]

Código http de respuesta en el header

datetime date-time

Fecha y hora de creación del plan

timestamp integer

Tiempo Unix o POSIX

data

object

suscripciones

object[]

Array [

suscripcion_id string

Id de suscripción cancelada

cliente_id string

Id de cliente suscrito a plan

estado string

Estado final de la suscripción

actualizado date-time

Fecha y hora de la cancelación

]

Example (from schema)

{
  "status": "success",
  "http_code": 200,
  "datetime": "2024-05-22T21:56:52.927Z",
  "timestamp": 0,
  "data": {
    "suscripciones": [
      {
        "suscripcion_id": "string",
        "cliente_id": "string",
        "estado": "string",
        "actualizado": "2024-05-22T21:56:52.927Z"
      }
    ]
  }
}

400

Error en petición

application/json

Schema

Schema

status string

Possible values: [error, fail]

Estatus de la petición

error

object

code integer

type string

message string
http_code integer

Código http de respuesta en el header

datetime date-time

Fecha y hora de creación.

timestamp integer

Tiempo Unix o POSIX

data object

Datos del error obtenido, sólo estará presente en errores HTTP 400

Example (from schema)

{
  "status": "error",
  "error": {
    "code": 0,
    "type": "string",
    "message": "string"
  },
  "http_code": 0,
  "datetime": "2024-05-22T21:56:52.927Z",
  "timestamp": 0,
  "data": {}
}

401

No autorizado

application/json

Schema

Schema

status string

Possible values: [error, fail]

Estatus de la petición

error

object

code integer

type string

message string
http_code integer

Código http de respuesta en el header

datetime date-time

Fecha y hora de creación.

timestamp integer

Tiempo Unix o POSIX

data object

Datos del error obtenido, sólo estará presente en errores HTTP 400

Example (from schema)

{
  "status": "error",
  "error": {
    "code": 0,
    "type": "string",
    "message": "string"
  },
  "http_code": 0,
  "datetime": "2024-05-22T21:56:52.927Z",
  "timestamp": 0,
  "data": {}
}

404

No se ha encontrado el recurso solicitado

application/json

Schema

Schema

status string

Possible values: [error, fail]

Estatus de la petición

error

object

code integer

type string

message string
http_code integer

Código http de respuesta en el header

datetime date-time

Fecha y hora de creación.

timestamp integer

Tiempo Unix o POSIX

data object

Datos del error obtenido, sólo estará presente en errores HTTP 400

Example (from schema)

{
  "status": "error",
  "error": {
    "code": 0,
    "type": "string",
    "message": "string"
  },
  "http_code": 0,
  "datetime": "2024-05-22T21:56:52.927Z",
  "timestamp": 0,
  "data": {}
}

4XX

Error en petición

application/json

Schema

Schema

status string

Possible values: [error, fail]

Estatus de la petición

error

object

code integer

type string

message string
http_code integer

Código http de respuesta en el header

datetime date-time

Fecha y hora de creación.

timestamp integer

Tiempo Unix o POSIX

data object

Datos del error obtenido, sólo estará presente en errores HTTP 400

Example (from schema)

{
  "status": "error",
  "error": {
    "code": 0,
    "type": "string",
    "message": "string"
  },
  "http_code": 0,
  "datetime": "2024-05-22T21:56:52.927Z",
  "timestamp": 0,
  "data": {}
}

5XX

Error interno

application/json

Schema

Schema

status string

Possible values: [error, fail]

Estatus de la petición

error

object

code integer

type string

message string
http_code integer

Código http de respuesta en el header

datetime date-time

Fecha y hora de creación.

timestamp integer

Tiempo Unix o POSIX

data object

Datos del error obtenido, sólo estará presente en errores HTTP 400

Example (from schema)

{
  "status": "error",
  "error": {
    "code": 0,
    "type": "string",
    "message": "string"
  },
  "http_code": 0,
  "datetime": "2024-05-22T21:56:52.927Z",
  "timestamp": 0,
  "data": {}
}

Loading...