Checkouts

Editar un checkout

Edita el borrador del checkout. name es obligatorio; el resto de los campos que omitas conservan su valor. El bloque commercial se aplica completo: si lo envías, reemplaza la configuración comercial anterior.

PATCH

/checkouts/{id}

Editar un checkout

curl --request PATCH \
  --url https://hub.grou.com/api/ext/checkouts/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "bonus_ids": [
    "<string>"
  ],
  "bootcamp_ids": [
    "<string>"
  ],
  "bumps": [
    {
      "enabled": true,
      "price": 123,
      "product_id": "<string>"
    }
  ],
  "commercial": {
    "base_currency": "USD",
    "dcc": {
      "base_country": "<string>",
      "enabled": true
    },
    "installment_plan": {
      "counts": [
        123
      ],
      "enabled": true
    },
    "pricing": [
      {
        "currency": "USD",
        "value": 123
      }
    ],
    "subscription_plans": [
      {
        "description": "<string>",
        "initial_price": 123,
        "name": "<string>",
        "plan_key": "<string>",
        "price": 123,
        "recurrence": {
          "count": 123,
          "unit": "DAY"
        },
        "trial_days": 123
      }
    ]
  },
  "coproduction": [
    {
      "mentor_id": "<string>",
      "percentage": 123
    }
  ],
  "design": {
    "thank_you": {
      "cta_text": "<string>",
      "cta_url": "<string>",
      "enabled": true,
      "message": "<string>",
      "title": "<string>"
    }
  },
  "discount": {
    "amount": 123,
    "percentage": 123,
    "type": "fixed"
  },
  "external_ref": "<string>",
  "name": "<string>",
  "product_ids": [
    "<string>"
  ],
  "slug": "<string>"
}
'

{
  "checkout_url": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "external_ref": "<string>",
  "id": "<string>",
  "state": "draft",
  "type": "program",
  "updated_at": "2023-11-07T05:31:56Z",
  "version_id": "<string>"
}

Authorizations

Authorizationstringheaderrequired

Tu API Key del Hub (Configuración → API Keys), que empieza por sk_. Solo se muestra una vez al generarla.

Path Parameters

idstringrequired

El id del recurso, tal como lo devolvió la API.

Body

bonus_idsstring[]

Productos de regalo.

bootcamp_idsstring[]

Talleres incluidos (publicados y tuyos).

bumpsobject[]

Productos adicionales que el comprador puede sumar.

Show child attributes

commercialobject

Configuración comercial. Un producto vende o un pago único (precio y cuotas opcionales) o planes de suscripción, no ambos. La tasa de interés de las cuotas se configura en el Hub y se conserva al editar.

Show child attributes

coproductionobject[]

Reparto de la coproducción. Incluye tu propio owner_user_id (de GET /me); los porcentajes deben sumar 100.

Show child attributes

designobject

Solo la página de agradecimiento. Las imágenes se suben con POST /checkouts/{id}/images; una URL de imagen aquí devuelve 400.

Show child attributes

discountobject

fixed: amount es el precio total a pagar en la moneda base (no un monto a restar). percentage: descuento porcentual.

Show child attributes

external_refstring

Minimum string length: 1

namestringrequired

Nombre interno del checkout.

Required string length: 1 - 120

product_idsstring[]

Programas y programas externos incluidos (publicados y tuyos).

slugstring

Final del link de pago (/c/{slug}). Único. Requerido para publicar.

Response

El checkout actualizado.

checkout_urlstring | nullrequired

Link de pago. Solo cuando el recurso está published.

created_atstringrequired

external_refstring | null

Tu identificador, si lo enviaste al crear.

idstringrequired

stateenum<string>required

draft: borrador, no visible para compradores. published: a la venta, con checkout_url. unpublished: retirado de la venta, se puede volver a publicar.

Available options: draft, published, unpublished

typeenum<string>required

Available options: program, external, workshop, checkout

updated_atstringrequired

version_idstring | null

Versión actual. Siempre null en checkouts.

Still need help? Share an idea