URL Base

Para hacer llamadas a la API, debes utilizar la siguiente URL base:
https://api.payclip.com

Objetos

Plan (Price)

Parámetro		Descripción	Tipo	Ejemplo	Notas
id		ID del plan de suscripción o “Price”.	String	“4b0e969b-8334-49c0-bb5c- 4ec658c99”	UUID v4
name		Nombre del plan de suscripción.	String	“Suscripción mensual”	Máximo 256 caracteres.
description		Descripción del plan.	String	“Plan de suscripción regular mensual”	Máximo 256 caracteres.
amount		Monto del plan.	Float	90.56	Máximo 2 decimales.
recurring		Objeto con la información de la periodicidad o recurrencia del pago.	Objeto
	interval	Intervalo en el que se cobrará el monto.	String	“month”	Únicos valores admitidos: “week” o “month”.
	frequency	Cada cuánto se ejecuta el ciclo de pago definido en “interval”.	Integer	1	Trabaja junto con el “interval”, ej. una frequency de 2 con un “interval” “month” hace referencia a un pago bimestral (cada dos meses).
	repeat	Cuántas veces se ejecutará el ciclo de pago.	Integer	6	Para duración indefinida se deja en 0. Si se define una duración específica el plan se cancelará automáticamente después de ese lapso de tiempo, ej. un “interval”:”month” con un “frequency”:1 y un “repeat”:6 indica un pago mensual con una duración de 6 meses.
	billing_day	Día en que se realizará el cargo a la tarjeta.	Integer Array	[15]	Para un “interval”:”week” los valores aceptados son del 1 al 7. Para un “interval”:”month” los valores aceptados son del 1 al 31.
	anchor_billing_on_first_payment	Si se define como true el día de pago será el mismo día que el primer pago.	Boolean	false	Si se pone como true, entonces el “billing_day” se deberá dejar vacío: [].
	subscription_link	Link para suscribirse a este plan.	String	“https://payclip.com/suscripcion/ 4b0e969b-8334”	Este link se lo debes compartir a tus clientes para que se suscriban a tu plan.
	grace_period_days	Indica cuántos días le vas a dar a tu cliente para realizar el pago antes de que se marque como “overdue” (vencido).	Integer	2	Para un “interval”:”week” acepta un valor entre el 0 y el 6. Para un “interval”:”month” acepta un valor entre el 0 y el 28.
status		Status del plan.	String	“active"	Posibles status: active o inactive.
additional_information		Sirve para pedirle alguna información adicional a tus clientes.	String	[“Número de alumno"] Si es más de uno: [“num1”, “num2”, “num3”, “num4”]	Es un campo dinámico. El nombre que definas aparecerá en el formulario de suscripción. Se permiten hasta 4 campos adicionales.
webhook_url		URL del endpoint que recibirá notificaciones webhook del link de pago.	String	“https://www.webhook.com”	Recibirás el ID del plan, suscripción o invoice y podrás consultar los detalles en los endpoints de consulta.
redirect_urls		Objeto con las URLs para redirección del cliente después del pago.	Objeto
	success	URL a la que se redireccionará al cliente cuando el pago es exitoso.	String	“https://www.misitio.com/success”
	error	URL a la que se redireccionará al cliente cuando han fallado varios intentos.	String	“https://www.misitio.com/error”
	default	URL de la tienda virtual.	String	“https://www.misitio.com”
created_at		Fecha de creación del plan.	String	"2024-04-09T10:39:59.994Z"	Formato ISO 8601 ( YYYY-MM-DDTHH-MM-SSZ
updated_at		Fecha de actualización del plan.	String	"2024-04-09T10:39:59.994Z"	Formato ISO 8601 ( YYYY-MM-DDTHH-MM-SSZ

El objeto completo en formato JSON se muestra a continuación:

{
    "id": "4b0e969b-8334-49c0-bb5c-4ec658c99",
    "name": "Nombre del plan",
    "description": "Descripción del plan",
    "amount": 90.50,
    "recurring": {
       "interval": "month",
       "frequency": 1,
       "repeat": 0,
       "billing_day": [15],
       "anchor_billing_on_first_payment": false,
"subscription_link":"https://pago.payclip.com/suscripcion/4b0e969b-8334-49c0-bb5c-4ec658c99",
        "grace_period_days": 2
    },
    "status": "active",
    "additional_information": [
        "Número de alumno",
        "Turno",
        "Materia",
        "Salón"
    ],
    "webhook_url":"https://webhook.com",
    "created_at": "2024-04-09T10:39:59.994Z",
    "updated_at": "2024-04-09T10:39:59.994Z",
    "redirect_urls": {
        "success": "https://www.misitio.com/success",
        "error": "https://www.misitio.com/error",
        "default": "https://www.misitio.com"
    }
}

Suscripción

Parámetro		Descripción	Tipo	Ejemplo	Notas
id		ID de la suscripción (suscription_id).	String	“48f94946-2d7a-43bc-9c59-4b99c7”	UUID v4
price_id		ID del plan o price al que está suscrito el cliente.	String	“0ba6bac3-ab6b-4f25-94d2-03cb955”	UUID v4
customer		Objeto con la información del cliente o suscriptor.	Objeto
	first_name	Nombre (s) del cliente.	String	“John”
	last_name	Apellido (s) del cliente.	String	“Doe”
	email	Correo del cliente.	String	“example@email.com”
	phone	Teléfono del cliente.	String	“5555555555”
status		Status de la suscripció:. active: Suscripción activa. inactive: Suscripción inactiva o cancelada. cancelled: La suscripción se canceló automáticamente al cancelarse el plan al que pertenece. concluded: La duración del plan terminó.	String	“active”	Posibles valores: active, inactive, cancelled o concluded. Únicamente se puede cambiar de active a inactive, los demás status son automáticos.
additional_information		Objeto con el nombre de los campos adicionales.	Objeto		Los campos adicionales es información que necesitas pedirle a tu cliente para manejar su suscripción, por ejemplo: Número de cliente, número de estudiante, etc.
	add_info_1	Nombre asignado al campo adicional.	String	“Número de estudiante”	Puedes tener hasta 4 campos adicioinales y se mostrarán numerados: add_info_1, add_info_2, add_info_3, add_info_4.
invoices		Información de los pagos pertenecientes a esta suscripción.	String	“13f246-2d7a-43bc-9c59-4b99c7”	Formato ISO 8601 ( YYYY-MM-DDTHH-MM-SSZ
start_date		Fecha de comienzo de la suscripción.	String	“2024-04-05T15:39:12.974359Z”	Formato ISO 8601 ( YYYY-MM-DDTHH-MM-SSZ
start_date		Fecha de finalización de la suscripción.	String	“2024-04-05T15:39:12.974359Z”	Formato ISO 8601 ( YYYY-MM-DDTHH-MM-SSZ
payment_method		método de pago.	String	“credit”	Posibles valores: credit, debit, cash, other.

El objeto completo en formato JSON se muestra a continuación:

{
    "id": "484946-2d7a-43bc-9c59-4b997b07",
    "price_id": "0bac3-ab6b-4f25-94d-03cb95e0",
    "customer": {
        "first_name": "Dong",
        "last_name": "Lee",
        "email": "corre@example.com",
        "phone": "5555555555"
    },
    "status": "active",
    "additional_information": {
        "add_info_1": "Número de estudiante",
        "add_info_2": "Materia",
        "add_info_3": "Turno",
        "add_info_4": "Salón"
    },
    "invoices": [
      {
            "id": "c6020bb2-e712-4d9f-86a6-c0ce8772",
            "subscription_id": "a1090385-5445-46aa-9c1c-ced829",
            "payment_request_id": "305a305a-0373-40cc-9684-add2e0",
            "amount": 0.01,
            "currency": null,
            "due_date": "2024-06-05T00:00:00Z",
            "status": "scheduled",
            "payment": null,
            "payment_method": {
                "type": "card",
                "card_details": {
                    "id": "230faf65-9264-49ca-be79-09a0aff",
                    "brand": "MC",
                    "last4": "1111",
                    "billing_address": null
                }
            },
            "payment_request_code": "V49H4",
            "additional_information": {
                "add_info_1": "12345",
                "add_info_2": "Español",
                "add_info_3": "Verpertino",
                "add_info_4": "13"
            },
            "period": null,
            "paid_at": null
        },
        {
            "id": "7e43e00a-16e6-4238-ac2f-c7fb6",
            "subscription_id": "a1090385-5445-46aa-9c1c-ce829",
            "payment_request_id": "32f46def-65ca-418e-9728-c7d8520",
            "amount": 0.01,
            "currency": null,
            "due_date": "2024-05-08T00:00:00Z",
            "status": "paid",
            "payment": null,
            "payment_method": {
                "type": "card",
                "card_details": {
                    "id": "230faf65-9264-49ca-be79-090aff",
                    "brand": "MC",
                    "last4": "2222",
                    "billing_address": null
                }
            },
            "payment_request_code": "3LQH73",
            "additional_information": {
                "add_info_1": "12345",
                "add_info_2": "Español",
                "add_info_3": "Verpertino",
                "add_info_4": "13"
            },
            "period": null,
            "paid_at": "2024-05-08T17:38:02.001051Z"
        }
    ],
    "start_date": "2024-04-05T15:39:12.974359Z",
    "end_date": "2024-04-05T15:40:12.488Z",
    "created_at": "2024-04-05T15:39:12.974359Z",
    "updated_at": "2024-04-05T15:40:12.488Z",
    "payment_method": "credit"
}

Invoice

Parámetro	Descripción	Tipo	Ejemplo	Notas
id	ID del invoice (invoice_id).	String	"5529d231-b3eb-4516-80d1-43db79e"	UUID v4
subscription_id	ID de la suscripción a la que pertenece este pago.	String	“61bcae6f-1919-4d1a-92aa-2648b36d"	UUID v4
payment_request_id	ID de la solicitud de pago.	String	"214d8cd2-9ebc-4372-9b06-cbaa26f"	UUID v4
amount	monto del invoice.	Float	90.50	Contiene máximo 2 decimales.
due_date	Fecha de vencimiento.	String	"2024-04-02T00:00:00Z"	Formato ISO 8601 (YYYY-MM-DDTHH-MM-SSZ)
status	Status del invoice.	String	“paid”	Posibles valores: scheduled, paid, requested, overdue,paidLate, cancelled

El objeto completo en formato JSON se muestra a continuación:

{
    "id": "5529d231-b3eb-4516-80d1-43db79e",
    "subscription_id": "61bcae6f-1919-4d1a-92aa-2648b36d",
    "payment_request_id": "214d8cd2-9ebc-4372-9b06-cbaa26f",
    "amount": 90.00,
    "due_date": "2024-04-02T00:00:00Z",
    "status": "paid"
}