Este endpoint regresa una lista de tus planes creados, tanto activos como inactivos.

Para realizar una llamada únicamente necesitas tu token de autenticación, no se necesitan query, path o body parameters en este caso.

Código de ejemplo

Ejemplo de una solicitud

El siguiente bloque de código es un ejemplo de una solicitud realizada al endpoint GET /prices:

curl --location 'https://api.payclip.com/prices' \
--header 'Authorization: Basic MTBkMTA2Y2QtMTI4Ny00MjI1LWE0ZWQtNzY3MWRkM2Y5ZDEzOjExNWYwMjE0LWJkZDgtNGY1ZS04ODRmLWVhMTM0YjVhNTUyNA==' \
--header 'Content-Type: application/json'

Ejemplo de una respuesta

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

[
    {
        "id": "a9941b07-aa81-4d6b-9680-bba90f23cbdb",
        "name": "Plan 1",
        "description": "Descripción del plan 1",
        "amount": 1000.50,
        "recurring": {
            "interval": "month",
            "frequency": 1,
            "repeat": 0,
            "billing_day": [
                10
            ],
            "anchor_billing_on_first_payment": false,
            "subscription_link": null,
            "grace_period_days": 2
        },
        "status": "active",
        "additional_information": [
            "Student ID"
        ],
        "webhook_url": "https://webhook.com",
        "created_at": "2024-03-14T22:35:07.254Z",
        "updated_at": "2024-03-14T22:35:07.254Z",
        "redirect_urls": {
            "success": "https://www.success.mx",
            "error": "https://www.error.com.mx",
            "default": "https://default.mx"
        }
    },    
    {
        "id": "63fb4671-6947-49a7-bbb2-80d33094280c",
        "name": "Plan 2",
        "description": "Descripción plan 2",
        "amount": 5000,
        "recurring": {
            "interval": "month",
            "frequency": 1,
            "repeat": 6,
            "billing_day": [
                28
            ],
            "anchor_billing_on_first_payment": false,
            "subscription_link": null,
            "grace_period_days": 2
        },
        "status": "active",
        "additional_information": [
            "Student ID"
        ],
        "webhook_url": "https://webhook.com",
        "created_at": "2024-03-15T07:37:36.175Z",
        "updated_at": "2024-03-15T07:37:36.175Z",
        "redirect_urls": {
            "success": "https://www.success.mx",
            "error": "https://www.error.com.mx",
            "default": "https://default.mx"
        }
    }
]

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
401	CL1501	Unauthorized
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": "AI1899",
"message": "Internal Error",
"detail": [
  "Error occurred while getting details"
  ]
}

Llamada de prueba

Para realizar una llamada de prueba únicamente asegúrate de poner tu token de autenticación en el campo "Header: Autorization" del widget localizado a tu derecha y dale click en "Try It!":

200Lista de planes obtenida exitosamente.