Dar de baja una membresía

curl --request POST \
  --url https://api.craqui.com/v1/memberships/{id}/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "at": "period_end"
}
'

import requests

url = "https://api.craqui.com/v1/memberships/{id}/cancel"

payload = { "at": "period_end" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({at: 'period_end'})
};

fetch('https://api.craqui.com/v1/memberships/{id}/cancel', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.craqui.com/v1/memberships/{id}/cancel",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'at' => 'period_end'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.craqui.com/v1/memberships/{id}/cancel"

	payload := strings.NewReader("{\n  \"at\": \"period_end\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.craqui.com/v1/memberships/{id}/cancel")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"at\": \"period_end\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.craqui.com/v1/memberships/{id}/cancel")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"at\": \"period_end\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "mem_01jhh1w4a8jm1t9s10yvrfmbf6",
  "object": "membership",
  "livemode": true,
  "client_id": "cli_01jqy553dmxw6vmq7g5vzfa9yz",
  "membership_plan_id": "mpl_01jj9hm7ppsd3qdfk8kksb0mv5",
  "status": "active",
  "current_period_start": "2026-11-02T00:00:00-03:00",
  "current_period_end": "2026-12-02T00:00:00-03:00",
  "renews_at": null,
  "next_credit_date": null,
  "started_at": "2026-03-02T00:00:00-03:00",
  "cancelled_at": "2026-12-01T11:40:02-03:00",
  "suspension_reason": null,
  "discount": {
    "percent": 10,
    "fixed_amount": null,
    "periods_remaining": 3
  },
  "active_freeze_id": null,
  "created_at": "2026-03-02T19:25:00-03:00",
  "updated_at": "2026-12-01T11:40:02-03:00",
  "changed": true
}

{
  "type": "https://docs.craqui.com/errors/invalid_api_key",
  "title": "La clave no es válida",
  "status": 401,
  "code": "invalid_api_key",
  "request_id": "req_01hzx8m4k2a7d9q3f5w6y8z0bc",
  "detail": "Revisa que copiaste la clave completa, incluido el prefijo (crq_live_ o crq_test_).",
  "doc_url": "<string>",
  "required_scope": "business:read",
  "errors": [
    {
      "field": "limit",
      "code": "invalid_limit",
      "detail": "<string>"
    }
  ],
  "current_price": {
    "amount_cents": 250000,
    "currency": "UYU"
  },
  "expected_amount": {
    "amount_cents": 250000,
    "currency": "UYU"
  },
  "amount_at_stake": {
    "amount_cents": 250000,
    "currency": "UYU"
  },
  "existing_membership_id": "mem_01j1q27t44qvr6v2s50cv4rbvq",
  "booking_ids": [
    "bkg_01jx9eak0437zdf0yw0atg7g0r"
  ]
}

{
  "type": "https://docs.craqui.com/errors/revoked_api_key",
  "title": "La clave fue revocada",
  "status": 401,
  "code": "revoked_api_key",
  "detail": "Crea una clave nueva en Configuración → Integraciones.",
  "request_id": "req_01hzx8m4k2a7d9q3f5w6y8z0bc"
}

{
  "type": "https://docs.craqui.com/errors/invalid_api_key",
  "title": "La clave no es válida",
  "status": 401,
  "code": "invalid_api_key",
  "request_id": "req_01hzx8m4k2a7d9q3f5w6y8z0bc",
  "detail": "Revisa que copiaste la clave completa, incluido el prefijo (crq_live_ o crq_test_).",
  "doc_url": "<string>",
  "required_scope": "business:read",
  "errors": [
    {
      "field": "limit",
      "code": "invalid_limit",
      "detail": "<string>"
    }
  ],
  "current_price": {
    "amount_cents": 250000,
    "currency": "UYU"
  },
  "expected_amount": {
    "amount_cents": 250000,
    "currency": "UYU"
  },
  "amount_at_stake": {
    "amount_cents": 250000,
    "currency": "UYU"
  },
  "existing_membership_id": "mem_01j1q27t44qvr6v2s50cv4rbvq",
  "booking_ids": [
    "bkg_01jx9eak0437zdf0yw0atg7g0r"
  ]
}

{
  "type": "https://docs.craqui.com/errors/invalid_api_key",
  "title": "La clave no es válida",
  "status": 401,
  "code": "invalid_api_key",
  "request_id": "req_01hzx8m4k2a7d9q3f5w6y8z0bc",
  "detail": "Revisa que copiaste la clave completa, incluido el prefijo (crq_live_ o crq_test_).",
  "doc_url": "<string>",
  "required_scope": "business:read",
  "errors": [
    {
      "field": "limit",
      "code": "invalid_limit",
      "detail": "<string>"
    }
  ],
  "current_price": {
    "amount_cents": 250000,
    "currency": "UYU"
  },
  "expected_amount": {
    "amount_cents": 250000,
    "currency": "UYU"
  },
  "amount_at_stake": {
    "amount_cents": 250000,
    "currency": "UYU"
  },
  "existing_membership_id": "mem_01j1q27t44qvr6v2s50cv4rbvq",
  "booking_ids": [
    "bkg_01jx9eak0437zdf0yw0atg7g0r"
  ]
}

{
  "type": "https://docs.craqui.com/errors/sandbox_unavailable",
  "title": "Tu estudio de prueba no está listo",
  "status": 409,
  "code": "sandbox_unavailable",
  "detail": "Restablece tus datos de prueba en Configuración → Integraciones y vuelve a intentar.",
  "request_id": "req_01hzx8m4k2a7d9q3f5w6y8z0bc"
}

{
  "type": "https://docs.craqui.com/errors/invalid_api_key",
  "title": "La clave no es válida",
  "status": 401,
  "code": "invalid_api_key",
  "request_id": "req_01hzx8m4k2a7d9q3f5w6y8z0bc",
  "detail": "Revisa que copiaste la clave completa, incluido el prefijo (crq_live_ o crq_test_).",
  "doc_url": "<string>",
  "required_scope": "business:read",
  "errors": [
    {
      "field": "limit",
      "code": "invalid_limit",
      "detail": "<string>"
    }
  ],
  "current_price": {
    "amount_cents": 250000,
    "currency": "UYU"
  },
  "expected_amount": {
    "amount_cents": 250000,
    "currency": "UYU"
  },
  "amount_at_stake": {
    "amount_cents": 250000,
    "currency": "UYU"
  },
  "existing_membership_id": "mem_01j1q27t44qvr6v2s50cv4rbvq",
  "booking_ids": [
    "bkg_01jx9eak0437zdf0yw0atg7g0r"
  ]
}

{
  "type": "https://docs.craqui.com/errors/invalid_api_key",
  "title": "La clave no es válida",
  "status": 401,
  "code": "invalid_api_key",
  "request_id": "req_01hzx8m4k2a7d9q3f5w6y8z0bc",
  "detail": "Revisa que copiaste la clave completa, incluido el prefijo (crq_live_ o crq_test_).",
  "doc_url": "<string>",
  "required_scope": "business:read",
  "errors": [
    {
      "field": "limit",
      "code": "invalid_limit",
      "detail": "<string>"
    }
  ],
  "current_price": {
    "amount_cents": 250000,
    "currency": "UYU"
  },
  "expected_amount": {
    "amount_cents": 250000,
    "currency": "UYU"
  },
  "amount_at_stake": {
    "amount_cents": 250000,
    "currency": "UYU"
  },
  "existing_membership_id": "mem_01j1q27t44qvr6v2s50cv4rbvq",
  "booking_ids": [
    "bkg_01jx9eak0437zdf0yw0atg7g0r"
  ]
}

{
  "type": "https://docs.craqui.com/errors/invalid_api_key",
  "title": "La clave no es válida",
  "status": 401,
  "code": "invalid_api_key",
  "request_id": "req_01hzx8m4k2a7d9q3f5w6y8z0bc",
  "detail": "Revisa que copiaste la clave completa, incluido el prefijo (crq_live_ o crq_test_).",
  "doc_url": "<string>",
  "required_scope": "business:read",
  "errors": [
    {
      "field": "limit",
      "code": "invalid_limit",
      "detail": "<string>"
    }
  ],
  "current_price": {
    "amount_cents": 250000,
    "currency": "UYU"
  },
  "expected_amount": {
    "amount_cents": 250000,
    "currency": "UYU"
  },
  "amount_at_stake": {
    "amount_cents": 250000,
    "currency": "UYU"
  },
  "existing_membership_id": "mem_01j1q27t44qvr6v2s50cv4rbvq",
  "booking_ids": [
    "bkg_01jx9eak0437zdf0yw0atg7g0r"
  ]
}

memberships

Dar de baja una membresía

Da de baja una membresía, igual que desde Craqui: at: "period_end" la programa para el fin del período (el cliente usa lo que le queda); at: "now" la termina hoy. Con now, decide qué pasa con la cuota del período en curso (current_fee); si la membresía tiene un pago por adelantado sin cobrar, decide también qué pasa con él (advance_payment_unpaid). La API no aplica ningún valor por defecto sobre plata. Al cliente le llega el aviso de siempre (notify: false lo silencia, con notifications:suppress). Responde la membresía como queda, con changed: false si la baja ya estaba programada. Con dry_run=true responde 200 con la vista previa.

Rechazos (409): membership_has_automatic_debit (primero se da de baja el débito, desde Craqui), membership_billed_by_card, automatic_debit_payment_in_flight, automatic_debit_charge_unassigned, pending_plan_change_paid, next_fee_already_paid, advance_payment_choice_required (con amount_at_stake), membership_not_active, membership_paused y client_inactive; 400 current_fee_choice_required. Una membresía que no es de tu negocio responde 404 not_found.

Una escritura de plata: lleva Idempotency-Key (salvo con dry_run=true), solo para estudios (en una academia responde wrong_vertical), solo si tu negocio tiene habilitada la escritura por la API (write_access_disabled si no) y además las escrituras de plata (money_writes_not_enabled si no). Cuenta para el límite de escrituras (30 por minuto) y para el de escrituras de plata (10 por minuto; una vista previa no cuenta para este). Un campo que el cuerpo no declara responde validation_failed con unknown_field. Un reintento con la misma Idempotency-Key, también después de las 24 horas, responde lo que ya se hizo, con Idempotent-Replayed: true.

POST

memberships

{id}

cancel

Dar de baja una membresía

curl --request POST \
  --url https://api.craqui.com/v1/memberships/{id}/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "at": "period_end"
}
'

import requests

url = "https://api.craqui.com/v1/memberships/{id}/cancel"

payload = { "at": "period_end" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({at: 'period_end'})
};

fetch('https://api.craqui.com/v1/memberships/{id}/cancel', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.craqui.com/v1/memberships/{id}/cancel",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'at' => 'period_end'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.craqui.com/v1/memberships/{id}/cancel"

	payload := strings.NewReader("{\n  \"at\": \"period_end\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.craqui.com/v1/memberships/{id}/cancel")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"at\": \"period_end\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.craqui.com/v1/memberships/{id}/cancel")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"at\": \"period_end\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "mem_01jhh1w4a8jm1t9s10yvrfmbf6",
  "object": "membership",
  "livemode": true,
  "client_id": "cli_01jqy553dmxw6vmq7g5vzfa9yz",
  "membership_plan_id": "mpl_01jj9hm7ppsd3qdfk8kksb0mv5",
  "status": "active",
  "current_period_start": "2026-11-02T00:00:00-03:00",
  "current_period_end": "2026-12-02T00:00:00-03:00",
  "renews_at": null,
  "next_credit_date": null,
  "started_at": "2026-03-02T00:00:00-03:00",
  "cancelled_at": "2026-12-01T11:40:02-03:00",
  "suspension_reason": null,
  "discount": {
    "percent": 10,
    "fixed_amount": null,
    "periods_remaining": 3
  },
  "active_freeze_id": null,
  "created_at": "2026-03-02T19:25:00-03:00",
  "updated_at": "2026-12-01T11:40:02-03:00",
  "changed": true
}

{
  "type": "https://docs.craqui.com/errors/invalid_api_key",
  "title": "La clave no es válida",
  "status": 401,
  "code": "invalid_api_key",
  "request_id": "req_01hzx8m4k2a7d9q3f5w6y8z0bc",
  "detail": "Revisa que copiaste la clave completa, incluido el prefijo (crq_live_ o crq_test_).",
  "doc_url": "<string>",
  "required_scope": "business:read",
  "errors": [
    {
      "field": "limit",
      "code": "invalid_limit",
      "detail": "<string>"
    }
  ],
  "current_price": {
    "amount_cents": 250000,
    "currency": "UYU"
  },
  "expected_amount": {
    "amount_cents": 250000,
    "currency": "UYU"
  },
  "amount_at_stake": {
    "amount_cents": 250000,
    "currency": "UYU"
  },
  "existing_membership_id": "mem_01j1q27t44qvr6v2s50cv4rbvq",
  "booking_ids": [
    "bkg_01jx9eak0437zdf0yw0atg7g0r"
  ]
}

{
  "type": "https://docs.craqui.com/errors/revoked_api_key",
  "title": "La clave fue revocada",
  "status": 401,
  "code": "revoked_api_key",
  "detail": "Crea una clave nueva en Configuración → Integraciones.",
  "request_id": "req_01hzx8m4k2a7d9q3f5w6y8z0bc"
}

{
  "type": "https://docs.craqui.com/errors/invalid_api_key",
  "title": "La clave no es válida",
  "status": 401,
  "code": "invalid_api_key",
  "request_id": "req_01hzx8m4k2a7d9q3f5w6y8z0bc",
  "detail": "Revisa que copiaste la clave completa, incluido el prefijo (crq_live_ o crq_test_).",
  "doc_url": "<string>",
  "required_scope": "business:read",
  "errors": [
    {
      "field": "limit",
      "code": "invalid_limit",
      "detail": "<string>"
    }
  ],
  "current_price": {
    "amount_cents": 250000,
    "currency": "UYU"
  },
  "expected_amount": {
    "amount_cents": 250000,
    "currency": "UYU"
  },
  "amount_at_stake": {
    "amount_cents": 250000,
    "currency": "UYU"
  },
  "existing_membership_id": "mem_01j1q27t44qvr6v2s50cv4rbvq",
  "booking_ids": [
    "bkg_01jx9eak0437zdf0yw0atg7g0r"
  ]
}

{
  "type": "https://docs.craqui.com/errors/invalid_api_key",
  "title": "La clave no es válida",
  "status": 401,
  "code": "invalid_api_key",
  "request_id": "req_01hzx8m4k2a7d9q3f5w6y8z0bc",
  "detail": "Revisa que copiaste la clave completa, incluido el prefijo (crq_live_ o crq_test_).",
  "doc_url": "<string>",
  "required_scope": "business:read",
  "errors": [
    {
      "field": "limit",
      "code": "invalid_limit",
      "detail": "<string>"
    }
  ],
  "current_price": {
    "amount_cents": 250000,
    "currency": "UYU"
  },
  "expected_amount": {
    "amount_cents": 250000,
    "currency": "UYU"
  },
  "amount_at_stake": {
    "amount_cents": 250000,
    "currency": "UYU"
  },
  "existing_membership_id": "mem_01j1q27t44qvr6v2s50cv4rbvq",
  "booking_ids": [
    "bkg_01jx9eak0437zdf0yw0atg7g0r"
  ]
}

{
  "type": "https://docs.craqui.com/errors/sandbox_unavailable",
  "title": "Tu estudio de prueba no está listo",
  "status": 409,
  "code": "sandbox_unavailable",
  "detail": "Restablece tus datos de prueba en Configuración → Integraciones y vuelve a intentar.",
  "request_id": "req_01hzx8m4k2a7d9q3f5w6y8z0bc"
}

{
  "type": "https://docs.craqui.com/errors/invalid_api_key",
  "title": "La clave no es válida",
  "status": 401,
  "code": "invalid_api_key",
  "request_id": "req_01hzx8m4k2a7d9q3f5w6y8z0bc",
  "detail": "Revisa que copiaste la clave completa, incluido el prefijo (crq_live_ o crq_test_).",
  "doc_url": "<string>",
  "required_scope": "business:read",
  "errors": [
    {
      "field": "limit",
      "code": "invalid_limit",
      "detail": "<string>"
    }
  ],
  "current_price": {
    "amount_cents": 250000,
    "currency": "UYU"
  },
  "expected_amount": {
    "amount_cents": 250000,
    "currency": "UYU"
  },
  "amount_at_stake": {
    "amount_cents": 250000,
    "currency": "UYU"
  },
  "existing_membership_id": "mem_01j1q27t44qvr6v2s50cv4rbvq",
  "booking_ids": [
    "bkg_01jx9eak0437zdf0yw0atg7g0r"
  ]
}

{
  "type": "https://docs.craqui.com/errors/invalid_api_key",
  "title": "La clave no es válida",
  "status": 401,
  "code": "invalid_api_key",
  "request_id": "req_01hzx8m4k2a7d9q3f5w6y8z0bc",
  "detail": "Revisa que copiaste la clave completa, incluido el prefijo (crq_live_ o crq_test_).",
  "doc_url": "<string>",
  "required_scope": "business:read",
  "errors": [
    {
      "field": "limit",
      "code": "invalid_limit",
      "detail": "<string>"
    }
  ],
  "current_price": {
    "amount_cents": 250000,
    "currency": "UYU"
  },
  "expected_amount": {
    "amount_cents": 250000,
    "currency": "UYU"
  },
  "amount_at_stake": {
    "amount_cents": 250000,
    "currency": "UYU"
  },
  "existing_membership_id": "mem_01j1q27t44qvr6v2s50cv4rbvq",
  "booking_ids": [
    "bkg_01jx9eak0437zdf0yw0atg7g0r"
  ]
}

{
  "type": "https://docs.craqui.com/errors/invalid_api_key",
  "title": "La clave no es válida",
  "status": 401,
  "code": "invalid_api_key",
  "request_id": "req_01hzx8m4k2a7d9q3f5w6y8z0bc",
  "detail": "Revisa que copiaste la clave completa, incluido el prefijo (crq_live_ o crq_test_).",
  "doc_url": "<string>",
  "required_scope": "business:read",
  "errors": [
    {
      "field": "limit",
      "code": "invalid_limit",
      "detail": "<string>"
    }
  ],
  "current_price": {
    "amount_cents": 250000,
    "currency": "UYU"
  },
  "expected_amount": {
    "amount_cents": 250000,
    "currency": "UYU"
  },
  "amount_at_stake": {
    "amount_cents": 250000,
    "currency": "UYU"
  },
  "existing_membership_id": "mem_01j1q27t44qvr6v2s50cv4rbvq",
  "booking_ids": [
    "bkg_01jx9eak0437zdf0yw0atg7g0r"
  ]
}

Authorizations

Authorization

string

header

required

Clave del negocio. sk es una clave completa (todo lo que el rol de quien la creó puede dar) y rk una restringida a los permisos que se eligieron al crearla. Solo se usa desde un servidor: un pedido desde un navegador se rechaza con browser_not_allowed.

Scopes

memberships:write

Asignar, cancelar, congelar y descongelar membresías.

Headers

Craqui-Version

string

Versión de la API para este pedido (YYYY-MM-DD). Si no la mandas, se usa la versión fijada en la clave cuando se creó.

Pattern: ^\d{4}-\d{2}-\d{2}$

Example:

"2026-12-01"

Idempotency-Key

string

Obligatorio en todo pedido que crea o cambia algo, salvo con dry_run=true. Un valor único por operación (por ejemplo un UUID). Si repites el pedido con la misma clave y el mismo cuerpo dentro de 24 horas, recibes la misma respuesta (con el header Idempotent-Replayed: true) sin que se repita el efecto, también la misma respuesta de error: para intentar de nuevo algo que se rechazó, usa una clave nueva. Con un dry_run=true la clave se ignora y no se guarda: el pedido real puede usar la misma. Pasadas las 24 horas, repetir una reserva con la misma clave y el mismo cuerpo sigue devolviendo la reserva que se hizo (como está ahora), y la misma clave con otro cuerpo responde idempotency_key_reused.

Required string length: 1 - 255

Path Parameters

string

required

El id de la membresía (mem_…). Id de una membresía de un cliente.

Pattern: ^mem_[0-7][0-9a-hjkmnp-tv-z]{25}$

Example:

"mem_01j1q27t44qvr6v2s50cv4rbvq"

Query Parameters

dry_run

boolean

true para ver qué pasaría sin hacerlo: Craqui evalúa el pedido con las mismas reglas que el real y responde 200 con un objeto preview, sin escribir nada ni avisarle a nadie. Cuenta para el límite de escrituras. false (o sin el parámetro) hace el pedido real. Es el único parámetro de consulta de una escritura.

Body

application/json

enum<string>

required

period_end programa la baja al fin del período; now la da de baja hoy.

Available options:

period_end,

now

current_fee

enum<string> | null

Obligatorio con at: "now" (400 current_fee_choice_required si falta): keep deja la cuota del período en curso para cobrar; retire la da de baja si no está pagada. Con period_end no se manda.

Available options:

keep,

retire,

null

advance_payment_unpaid

enum<string> | null

Solo si la membresía tiene un pago por adelantado con la cuota sin pagar (409 advance_payment_choice_required con amount_at_stake si hace falta y no vino): prorate cobra solo lo usado, keep lo cobra entero, retire no lo cobra.

Available options:

prorate,

keep,

retire,

null

notify

boolean

default:true

false para no enviarle al cliente los avisos de esta escritura (email, WhatsApp). Necesita el permiso notifications:suppress; sin él, la respuesta es 403 scope_required. Nunca silencia el aviso a otra persona: si una cancelación hace entrar a alguien de la lista de espera, esa persona se entera igual. Los recordatorios posteriores salen igual. Por defecto true. Tu estudio de prueba no le avisa a nadie, diga lo que diga este campo.

Response

La membresía como quedó, o con dry_run=true la vista previa (object dice cuál).

Option 1
Option 2

La membresía como quedó, con changed.

string

required

Id de una membresía de un cliente.

Pattern: ^mem_[0-7][0-9a-hjkmnp-tv-z]{25}$

Example:

"mem_01j1q27t44qvr6v2s50cv4rbvq"

object

string

required

Allowed value: "membership"

livemode

boolean

required

false si el objeto es de tu estudio de prueba (claves crq_test_); true con claves crq_live_.

client_id

string | null

required

El cliente. null si la membresía es de alguien que no es cliente del estudio.

Pattern: ^cli_[0-7][0-9a-hjkmnp-tv-z]{25}$

Example:

"cli_01jatfha5h4nkg77c3wfrvd3cw"

membership_plan_id

string

required

Id de un plan de membresía.

Pattern: ^mpl_[0-7][0-9a-hjkmnp-tv-z]{25}$

Example:

"mpl_01jt05nvk11xa1zm1pwve2qj7r"

status

enum<string>

required

active, paused (congelada), suspended, pending_payment, cancelled o expired. La lista puede crecer: trata un valor que no conoces como una membresía que no da créditos.

Available options:

active,

paused,

suspended,

pending_payment,

cancelled,

expired

current_period_start

string<date-time>

required

Instante en RFC 3339 con el offset del negocio en ese momento.

Example:

"2026-12-02T19:00:00-03:00"

current_period_end

string<date-time>

required

Instante en RFC 3339 con el offset del negocio en ese momento.

Example:

"2026-12-02T19:00:00-03:00"

renews_at

string<date-time> | null

required

Cuándo se renueva sola: el fin del período actual si la membresía está active y su plan se renueva solo; si no, null.

Example:

"2026-12-02T19:00:00-03:00"

next_credit_date

string<date> | null

required

La fecha local en que recibe los próximos créditos; null si no hay una prevista.

Pattern: ^\d{4}-\d{2}-\d{2}$

Example:

"2026-12-02"

started_at

string<date-time>

required

Instante en RFC 3339 con el offset del negocio en ese momento.

Example:

"2026-12-02T19:00:00-03:00"

cancelled_at

string<date-time> | null

required

Instante en RFC 3339 con el offset del negocio en ese momento.

Example:

"2026-12-02T19:00:00-03:00"

suspension_reason

string | null

required

Por qué se suspendió, como texto; null si no está suspendida.

discount

object | null

required

El descuento que tiene la membresía; null si no tiene.

Show child attributes

active_freeze_id

string | null

required

El congelamiento en curso o programado; null si no hay. El detalle está en GET /v1/memberships/{id}/freezes.

Pattern: ^frz_[0-7][0-9a-hjkmnp-tv-z]{25}$

Example:

"frz_01jtk6e3z2vm9ych2cc7kadyja"

created_at

string<date-time>

required

Instante en RFC 3339 con el offset del negocio en ese momento.

Example:

"2026-12-02T19:00:00-03:00"

updated_at

string<date-time>

required

Instante en RFC 3339 con el offset del negocio en ese momento.

Example:

"2026-12-02T19:00:00-03:00"

changed

boolean

required

false si la baja ya estaba programada: no cambió nada y no se avisó de nuevo.

business

booking_policy

centers

rooms

teachers

courses

classes

credit_packs

membership_plans

intro_offers

sessions

clients

bookings

credits

memberships

fees

payments

refunds

events

webhook_endpoints

Dar de baja una membresía

Authorizations

Scopes

Headers

Path Parameters

Query Parameters

Body

Response