Retorna los detalles de un plan específico usando su ID.
Este endpoint regresa los detalles de un plan específico por medio de su id.
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 |
|
|
price_id |
id del plan a modificar. |
String |
Requerido |
1960c5eb-d9ed-4a55-8d65-a377b5 |
UUID v4 |
|
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/{price_id}:
curl --location 'https://api.payclip.com/prices/0ba6bac3-ab6b-4f25-94d2-03cb57dde0' \
--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": "0ba6bac3-ab6b-4f25-94d2-03cb57dde0",
"name": "Plan 1",
"description": "Descripción del plan",
"amount": 90.00,
"recurring": {
"interval": "month",
"frequency": 1,
"repeat": 0,
"billing_day": [
30
],
"anchor_billing_on_first_payment": false,
"subscription_link": "https://pago.payclip.com/suscripcion/0b6bac3-ab6b-4f25-94d2-03e00",
"grace_period_days": 28
},
"status": "active",
"additional_information": [
"número de alumno",
"número de salón",
"horario",
"materia"
],
"webhook_url": "https://webhook.com",
"created_at": "2024-04-05T15:29:13.184Z",
"updated_at": "2024-04-05T15:29:13.184Z",
"redirect_urls": {
"success": "https://www.success.mx/",
"error": "https://www.error.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 |
|
|
404 |
BR1301 |
Price 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": "BR1301",
"message": "Internal Error",
"detail": [
"Price object not found"
]
}
Llamada de prueba
Puedes realizar una llamada de prueba llenando los campos necesarios en el formulario que se muestra abajo.
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!":
