curl --request POST \
  --url https://api.sandbox.z2pay.com/v1/plans/{id}/items \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "item": {
    "key": "<string>",
    "name": "<string>",
    "kind": "recurring",
    "quantityDefault": 1,
    "displayOrder": 0,
    "description": "<string>",
    "metadata": {}
  },
  "price": {
    "amount": 1,
    "billingScheme": "fixed",
    "currency": "BRL"
  }
}
'

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    item: {
      key: '<string>',
      name: '<string>',
      kind: 'recurring',
      quantityDefault: 1,
      displayOrder: 0,
      description: '<string>',
      metadata: {}
    },
    price: {amount: 1, billingScheme: 'fixed', currency: 'BRL'}
  })
};

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

import requests

url = "https://api.sandbox.z2pay.com/v1/plans/{id}/items"

payload = {
    "item": {
        "key": "<string>",
        "name": "<string>",
        "kind": "recurring",
        "quantityDefault": 1,
        "displayOrder": 0,
        "description": "<string>",
        "metadata": {}
    },
    "price": {
        "amount": 1,
        "billingScheme": "fixed",
        "currency": "BRL"
    }
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "id": "pli_n8e7y0yrg2frgqpktke850zqo",
  "planId": "plan_lhutpqeq2ml3stia4vn90xars",
  "key": "wine",
  "name": "Monthly Wine Bottle",
  "kind": "recurring",
  "quantityDefault": 1,
  "displayOrder": 2,
  "description": "Add-on wine bottle each cycle",
  "metadata": {},
  "createdAt": "2025-06-29T17:00:00.000Z",
  "updatedAt": "2025-06-29T17:00:00.000Z",
  "currentPrice": {
    "id": "price_hmy57z19gvf70wufibh1bqstb",
    "planItemId": "pli_n8e7y0yrg2frgqpktke850zqo",
    "planId": "plan_lhutpqeq2ml3stia4vn90xars",
    "billingScheme": "fixed",
    "amount": 4900,
    "currency": "BRL",
    "recurrence": {
      "interval": 1,
      "unit": "month",
      "anchor": "subscription_start",
      "collectionTiming": "prepaid"
    },
    "trialSpec": null,
    "isCurrent": true,
    "publishedAt": "2025-06-29T17:00:00.000Z",
    "archivedAt": null,
    "createdAt": "2025-06-29T17:00:00.000Z",
    "updatedAt": "2025-06-29T17:00:00.000Z"
  }
}

{
  "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": "NOT_FOUND",
    "message": "Item not found"
  }
}

{
  "error": {
    "code": "CONFLICT",
    "message": "No refundable payment found"
  }
}

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