Obtener un contrato

GET

https://app.recurrente.com/api/contracts/:id

GET

/api/contracts/:id

curl https://app.recurrente.com/api/contracts/id \
     -H "X-SECRET-KEY: <apiKey>" \
     -H "Content-Type: application/json"

200Retrieved

{
  "id": "ctr_9f8e7d6c",
  "account_id": "acc_4b3a2c1d",
  "template_id": "ctpl_7a6b5c4d",
  "customer": {
    "id": "cus_12345678",
    "name": "María López",
    "email": "maria.lopez@example.com",
    "phone": "+502 5554 3210"
  },
  "booking_id": "bk_20240401_001",
  "checkout_id": "chk_98765432",
  "checkout_url": "https://app.recurrente.com/payments/checkout/chk_98765432",
  "title": "Contrato de Servicios de Consultoría",
  "status": "sent",
  "sent_via": "whatsapp",
  "signing_url": "https://app.recurrente.com/contracts/sign/ctr_9f8e7d6c?token=abc123xyz",
  "field_values": {
    "full_name": "María López",
    "date_of_birth": "1985-07-20",
    "consent": "accepted"
  },
  "verified_channel": "whatsapp",
  "body_sha256": "3a7bd3e2360a3d5f8b9c1e2f4d5a6b7c8d9e0f1a2b3c4d5e6f7a8b9c0d1e2f3a",
  "pdf_available": true,
  "viewed_at": "2024-04-10T14:22:00Z",
  "signed_at": "2024-04-10T14:30:00Z",
  "valid_until": "2024-05-10T23:59:59Z",
  "declined_at": null,
  "decline_reason": null,
  "reminder_sent_at": "2024-04-09T10:00:00Z",
  "created_at": "2024-04-01T08:00:00Z"
}

Authentication

X-SECRET-KEYstring

Tu clave secreta de API.

Una llave de cuenta (sk_live_..., sk_test_...) opera sobre su propia cuenta y, con X-ACCOUNT-ID, sobre sus cuentas conectadas.

La llave también fija el ambiente: una sk_test_ solo lista y resuelve objetos de prueba (live_mode: false) y una sk_live_ solo objetos reales. Un ID del otro ambiente responde 404 (401 en /customers).

Una llave de organización (sk_org_live_..., sk_org_test_...) alcanza todas las cuentas de una organización y solo sirve para leer: saldos, movimientos y reportes. Para operar sobre una cuenta debe nombrarla con X-ACCOUNT-ID; omitirlo en una lectura devuelve todas las cuentas de la organización. Cualquier otro endpoint responde 403 con code: organization_key_unsupported.

Path parameters

idstringRequired

Response

El contrato

idstringOptional

account_idstringOptional

template_idstringOptional

customerobjectOptional

booking_idstring or nullOptional

La cita que lo pidió, si vino de una.

checkout_idstring or nullOptional

El cobro que se paga después de firmar.

checkout_urlstring or nullOptional

titlestringOptional

statusenumOptional

Allowed values:

sent_viaenum or nullOptional

Allowed values:

signing_urlstringOptional

La página donde el cliente lee y firma (link firmado).

field_valuesobjectOptional

Lo que el cliente llenó al firmar, por key del campo.

verified_channelenum or nullOptional

Por dónde confirmó su identidad con un código antes de firmar.

Allowed values:

body_sha256string or nullOptional

SHA-256 del texto firmado.

pdf_availablebooleanOptional

Si ya se puede descargar el PDF firmado.

viewed_atdatetime or nullOptional

signed_atdatetime or nullOptional

valid_untildatetime or nullOptional

declined_atdatetime or nullOptional

decline_reasonstring or nullOptional

reminder_sent_atdatetime or nullOptional

created_atdatetimeOptional