curl --request PATCH \
  --url https://api.sandbox.z2pay.com/v1/checkout/links/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "slug": "<string>",
  "mode": "payment",
  "currency": "BRL",
  "locale": "pt-BR",
  "items": [],
  "paymentMethods": {},
  "splits": [
    {
      "recipientId": "<string>",
      "percentage": 50.005,
      "liable": true,
      "processingFee": true
    }
  ],
  "branding": {
    "primaryColor": "<string>",
    "logoUrl": "<string>",
    "merchantName": "<string>",
    "faviconUrl": "<string>",
    "coverUrl": "<string>"
  },
  "subscription": {
    "planId": "<string>",
    "currency": "BRL",
    "trialDays": 182,
    "maxCycles": 1,
    "collectionTiming": "prepaid",
    "metadata": {},
    "itemCovers": {},
    "maxEnrollmentInstallments": 1
  },
  "requiredFields": [],
  "customFields": [
    {
      "key": "<string>",
      "label": "<string>",
      "options": [
        "<string>"
      ],
      "required": true
    }
  ],
  "successUrl": "<string>",
  "cancelUrl": "<string>",
  "metadata": {},
  "expirationMinutes": 21602
}
'

const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    description: '<string>',
    slug: '<string>',
    mode: 'payment',
    currency: 'BRL',
    locale: 'pt-BR',
    items: [],
    paymentMethods: {},
    splits: [
      {recipientId: '<string>', percentage: 50.005, liable: true, processingFee: true}
    ],
    branding: {
      primaryColor: '<string>',
      logoUrl: '<string>',
      merchantName: '<string>',
      faviconUrl: '<string>',
      coverUrl: '<string>'
    },
    subscription: {
      planId: '<string>',
      currency: 'BRL',
      trialDays: 182,
      maxCycles: 1,
      collectionTiming: 'prepaid',
      metadata: {},
      itemCovers: {},
      maxEnrollmentInstallments: 1
    },
    requiredFields: [],
    customFields: [{key: '<string>', label: '<string>', options: ['<string>'], required: true}],
    successUrl: '<string>',
    cancelUrl: '<string>',
    metadata: {},
    expirationMinutes: 21602
  })
};

fetch('https://api.sandbox.z2pay.com/v1/checkout/links/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.sandbox.z2pay.com/v1/checkout/links/{id}"

payload = {
    "name": "<string>",
    "description": "<string>",
    "slug": "<string>",
    "mode": "payment",
    "currency": "BRL",
    "locale": "pt-BR",
    "items": [],
    "paymentMethods": {},
    "splits": [
        {
            "recipientId": "<string>",
            "percentage": 50.005,
            "liable": True,
            "processingFee": True
        }
    ],
    "branding": {
        "primaryColor": "<string>",
        "logoUrl": "<string>",
        "merchantName": "<string>",
        "faviconUrl": "<string>",
        "coverUrl": "<string>"
    },
    "subscription": {
        "planId": "<string>",
        "currency": "BRL",
        "trialDays": 182,
        "maxCycles": 1,
        "collectionTiming": "prepaid",
        "metadata": {},
        "itemCovers": {},
        "maxEnrollmentInstallments": 1
    },
    "requiredFields": [],
    "customFields": [
        {
            "key": "<string>",
            "label": "<string>",
            "options": ["<string>"],
            "required": True
        }
    ],
    "successUrl": "<string>",
    "cancelUrl": "<string>",
    "metadata": {},
    "expirationMinutes": 21602
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "id": "chk_byd8p3p79re859jpkmr0j65n3",
  "slug": "plano-pro-mensal",
  "status": "active",
  "mode": "subscription",
  "currency": "BRL",
  "locale": "pt-BR",
  "name": "Plano Pro Mensal",
  "description": "Assinatura mensal do plano Pro",
  "sellable": true,
  "config": {
    "items": [
      {
        "name": "Plano Pro",
        "quantity": 1,
        "unitAmount": 9900,
        "chargeType": "recurring"
      }
    ],
    "paymentMethods": {
      "card": {
        "enabled": true
      },
      "pix": {
        "enabled": true
      }
    },
    "subscription": {
      "planId": "plan_edz8m3vbxbvobrom0qlxbq68h",
      "recurrence": {
        "interval": 1,
        "unit": "month"
      },
      "currency": "BRL",
      "trialDays": 7,
      "collectionTiming": "prepaid"
    }
  },
  "requiredFields": [
    "email",
    "document",
    "phone"
  ],
  "customFields": null,
  "successUrl": "https://app.com/welcome",
  "cancelUrl": null,
  "metadata": null,
  "expirationMinutes": 1440,
  "createdAt": "2025-06-20T09:00:00.000Z",
  "updatedAt": "2025-06-29T13:45:30.000Z",
  "url": "https://pay.z2pay.com/c/plano-pro-mensal"
}

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Validation failed",
    "issues": [
      {
        "path": "status",
        "message": "Status inválido. Valores aceitos: pending, waiting_payment, paid, refused, canceled, refunded"
      },
      {
        "path": "startDate",
        "message": "Data deve ser ISO 8601 com timezone (ex.: 2026-06-24T00:00:00Z)"
      }
    ]
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid API key"
  }
}

{
  "error": {
    "code": "FORBIDDEN",
    "message": "Forbidden — insufficient permissions"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Checkout link not found"
  }
}

{
  "error": "A request with this idempotency key is already being processed"
}

{
  "error": "Idempotency key already used with a different request body"
}