Atualizar um produto

curl -X POST "https://api.chargefy.io/v1/products/prod_3eonkjsawE9Txa22" \
  -H "Authorization: Bearer {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
    "default_price_id": "price_AHTje79fT93mPEvY",
    "name": "Plano Pro Plus"
  }'

{
  "id": "prod_3eonkjsawE9Txa22",
  "object": "product",
  "created_at": "2026-05-16T14:09:27Z",
  "default_price": "price_AHTje79fT93mPEvY",
  "description": "Acesso completo",
  "image_url": null,
  "is_active": true,
  "is_tax_applicable": true,
  "livemode": true,
  "marketing_features": [
    {
      "name": "Acesso ilimitado"
    },
    {
      "name": "Suporte prioritário"
    }
  ],
  "metadata": {},
  "name": "Plano Pro Plus",
  "prices": [
    {
      "id": "price_AHTje79fT93mPEvY",
      "object": "price",
      "created_at": "2026-05-16T14:30:00Z",
      "currency": "brl",
      "is_active": true,
      "livemode": true,
      "metadata": {},
      "name": "Anual",
      "product": "prod_3eonkjsawE9Txa22",
      "recurring": {
        "interval": "year",
        "interval_count": 1,
        "trial_period_days": null,
        "usage_type": "licensed"
      },
      "tax_behavior": "unspecified",
      "type": "recurring",
      "unit_amount": 99000,
      "updated_at": null
    }
  ],
  "updated_at": "2026-05-16T15:02:10Z"
}

Atualiza um product com semântica de merge: campos ausentes ficam como estão; envie null para limpar campos opcionais. metadata e marketing_features, quando enviados, substituem a lista/objeto inteiro. A resposta direta não carrega diff; quem precisa de diff lê o webhook product.updated.

Autenticação

A API key da própria organização atua diretamente. A API key de plataforma exige o header Organization: <organization_id> apontando para uma organização conectada ativa.

Parâmetros de caminho

string

required

ID do produto (prod_*).

Attributes

Todos os campos são opcionais.

string \| null

Aponta o default_price_id para outro preço existente do mesmo produto. Envie null para limpar.

string \| null

Nova descrição. Envie null para limpar.

string \| null

Nova imagem. Use a URL retornada por POST /v1/files com purpose=product_image. Envie null para limpar. URLs externas não são aceitas.

boolean

false tira o produto de novos fluxos de compra. true reativa.

boolean

Ajusta a flag tributável.

array

Substitui completamente a lista de recursos de marketing quando enviado. No máximo 15 itens; cada name até 80 caracteres. Envie [] para limpar.

Show marketing_features

string

required

Texto do recurso. Até 80 caracteres.

object

Substitui completamente o metadata atual quando enviado.

string

Novo nome. Quando enviado, não pode ser vazio.

curl -X POST "https://api.chargefy.io/v1/products/prod_3eonkjsawE9Txa22" \
  -H "Authorization: Bearer {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
    "default_price_id": "price_AHTje79fT93mPEvY",
    "name": "Plano Pro Plus"
  }'

Resposta

200 OK com o objeto product completo (mesmo shape de GET /v1/products/:id).

{
  "id": "prod_3eonkjsawE9Txa22",
  "object": "product",
  "created_at": "2026-05-16T14:09:27Z",
  "default_price": "price_AHTje79fT93mPEvY",
  "description": "Acesso completo",
  "image_url": null,
  "is_active": true,
  "is_tax_applicable": true,
  "livemode": true,
  "marketing_features": [
    {
      "name": "Acesso ilimitado"
    },
    {
      "name": "Suporte prioritário"
    }
  ],
  "metadata": {},
  "name": "Plano Pro Plus",
  "prices": [
    {
      "id": "price_AHTje79fT93mPEvY",
      "object": "price",
      "created_at": "2026-05-16T14:30:00Z",
      "currency": "brl",
      "is_active": true,
      "livemode": true,
      "metadata": {},
      "name": "Anual",
      "product": "prod_3eonkjsawE9Txa22",
      "recurring": {
        "interval": "year",
        "interval_count": 1,
        "trial_period_days": null,
        "usage_type": "licensed"
      },
      "tax_behavior": "unspecified",
      "type": "recurring",
      "unit_amount": 99000,
      "updated_at": null
    }
  ],
  "updated_at": "2026-05-16T15:02:10Z"
}

Erros comuns

Status	`code`	Quando ocorre
`400`	`invalid_request`	`name` enviado vazio; `is_tax_applicable`/`is_active` não-boolean; `metadata` não-objeto; `default_price_id` não pertence ao produto
`400`	`invalid_request`	`marketing_features` não-array; mais de 15 itens; `marketing_features[N].name` ausente/vazio ou acima de 80 caracteres
`400`	`invalid_request`	`image_url` não aponta para um `file` ativo de `purpose=product_image` da organização
`404`	`resource_missing`	Produto não existe nesta organização

Webhook

A atualização dispara product.updated com o product completo em data.object e o diff em data.previous_attributes.

curl -X POST "https://api.chargefy.io/v1/products/prod_3eonkjsawE9Txa22" \
  -H "Authorization: Bearer {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
    "default_price_id": "price_AHTje79fT93mPEvY",
    "name": "Plano Pro Plus"
  }'

{
  "id": "prod_3eonkjsawE9Txa22",
  "object": "product",
  "created_at": "2026-05-16T14:09:27Z",
  "default_price": "price_AHTje79fT93mPEvY",
  "description": "Acesso completo",
  "image_url": null,
  "is_active": true,
  "is_tax_applicable": true,
  "livemode": true,
  "marketing_features": [
    {
      "name": "Acesso ilimitado"
    },
    {
      "name": "Suporte prioritário"
    }
  ],
  "metadata": {},
  "name": "Plano Pro Plus",
  "prices": [
    {
      "id": "price_AHTje79fT93mPEvY",
      "object": "price",
      "created_at": "2026-05-16T14:30:00Z",
      "currency": "brl",
      "is_active": true,
      "livemode": true,
      "metadata": {},
      "name": "Anual",
      "product": "prod_3eonkjsawE9Txa22",
      "recurring": {
        "interval": "year",
        "interval_count": 1,
        "trial_period_days": null,
        "usage_type": "licensed"
      },
      "tax_behavior": "unspecified",
      "type": "recurring",
      "unit_amount": 99000,
      "updated_at": null
    }
  ],
  "updated_at": "2026-05-16T15:02:10Z"
}

Fundamentos da API

Objetos de sistema

Webhooks e eventos

SDKs

MCP

Atualizar um produto

Autenticação

Parâmetros de caminho

Attributes

Resposta

Erros comuns

Webhook

​Autenticação

​Parâmetros de caminho

​Attributes

​Resposta

​Erros comuns

​Webhook

Autenticação

Parâmetros de caminho

Attributes

Resposta

Erros comuns

Webhook