Actualizar una suscripción

Permite actualizar el estado de una suscripción.

Este endpoint te permite cancelar una suscripción.

El status únicamente se puede cambiar de active a inactive. Una vez inactivo no se puede volver a activar.


Header parameters

La siguiente tabla describe el esquema de los parámetros de encabezado o headers:

Parámetro

Descripción

Tipo

Requerido / Opcional

Notas

Content-Type

Define el formato del objeto de la llamada

application/json

Requerido

Solicitud en formato JSON

Authorization

Especifica el token de acceso

String

Requerido

token de autenticación


Path parameters

La siguiente tabla describe el esquema de los parámetros de ruta:

Parámetro

Descripción

Tipo

Requerido / Opcional

Ejemplo

Notas

suscription_id

id de la suscripción a cancelar.

String

Requerido

1960c5eb-d9ed-4a55-8d65-a377b5

UUID v4


Body parameters (parámetros del cuerpo de la solicitud)

A continuación se describe el esquema de los parámetros del body de la solicitud de pago:

Parámetro

Descripción

Tipo

Ejemplo

Requerido / Opcional

Notas

status

Status de la suscripción.

String

“inactive”

Requerido

Sólo puede cambiar a “inactive”.


Código de ejemplo

Ejemplo de una solicitud

El siguiente bloque de código es un ejemplo de una solicitud realizada al endpoint PUT /subscriptions/{id}:

curl --location --request PUT 'https://api.payclip.com/subscriptions/b0b8ddb1-17cd-4a80-8ccf-596f9a9eabe2' \
--header 'Authorization: Basic MTBkMTA2Y2QtMTI4Ny00MjI1LWE0ZWQtNzY3MWRkM2Y5ZDEzOjExNWYwMjE0LWJkZDgtNGY1ZS04ODRmLWVhMTM0YjVhNTUyNA==' \
--header 'Content-Type: application/json' \
--data '{
    
     "status":"inactive"
}'

Ejemplo de una respuesta

El siguiente objeto es una respuesta de éxito con código HTTP 201 OK:

{
    "id": "b0b8ddb1-17cd-4a80-8ccf-596f9a9eabe2",
    "price_id": "756103d4-4aea-457e-a433-623ad7c7299c",
    "customer": {
        "first_name": "John",
        "last_name": "Doe",
        "email": "[email protected]",
        "phone": "5555555555"
    },
    "status": "inactive",
    "additional_information": {
        "add_info_1": "12345",
        "add_info_2": "Cálculo",
        "add_info_3": "Vespertino"
    },
    "invoices": [
        {
            "id": "2134a656-47c8-43d9-afd6-618c8c3a6f88",
            "subscription_id": "b0b8ddb1-17cd-4a80-8ccf-596f9a9eabe2",
            "payment_request_id": "c047db3b-709c-4564-b49f-8d8ef30c1442",
            "amount": 90.50,
            "currency": null,
            "due_date": "2024-04-10T00:00:00Z",
            "status": "scheduled",
            "payment": null,
            "payment_method": {
                "type": "payment_link"
            },
            "payment_request_code": "LVNKF868",
            "additional_information": {
                "add_info_1": "12345",
                "add_info_2": "Cálculo",
                "add_info_3": "Verspertino"
            },
            "period": null,
            "paid_at": null
        }
    ],
    "start_date": null,
    "end_date": null,
    "created_at": "2024-04-10T22:20:12.592926Z",
    "updated_at": "2024-04-10T22:20:42.568Z",
    "payment_method": {
        "type": "payment_link"
    }
}

Códigos de respuesta

La siguiente tabla contiene una lista de los códigos de respuesta y su asociación con algunos de los estados HTTP:

Estado HTTP

Error code

Mensaje

400

CL2204

Allowed Status is : inactive

401

CL1501

Unauthorized

404

BR1302

Subscription object not found

500

AI1899

Internal error.


Ejemplo de una respuesta conteniendo un código de error en formato JSON. En este ejemplo se comparte el código de error en el campo “error_code”, la descripción en el campo “message” y dentro del objeto “detail” más información:

{
"error_code": "CL2204",
"message": "Bad Request",
"detail": [
  "Allowed Status is : inactive"
  ]
}

Realiza una llamada de prueba:

Language
Click Try It! to start a request and see the response here!