Referência de planos de taxas
Listar planos de taxas
Lista os planos de taxas da sua plataforma.
curl -X GET "https://api.chargefy.io/v1/fee-plans?is_default=true" \
-H "Authorization: Bearer {{PLATFORM_API_KEY}}"
{
"object": "list",
"data": [
{
"id": "plan_nVTh3XtU",
"object": "fee_plan",
"created_at": "2026-09-26T10:00:00Z",
"description": null,
"fee_calculation_base": "chargeable",
"installment_plan": "00349",
"is_default": true,
"livemode": true,
"metadata": {},
"name": "Padrão",
"prepaid": true,
"rates": [
{
"id": "rate_UbDhy9GD",
"card_brand": null,
"currency": "brl",
"fee_rate": 0,
"fixed_fee_amount": 349,
"installments": 1,
"payment_method_type": "boleto",
"settlement_days": 6
},
{
"id": "rate_PKj9TALF",
"card_brand": null,
"currency": "brl",
"fee_rate": 399,
"fixed_fee_amount": 0,
"installments": 1,
"payment_method_type": "credit_card",
"settlement_days": 30
},
{
"id": "rate_FHH9VpEY",
"card_brand": "visa",
"currency": "brl",
"fee_rate": 399,
"fixed_fee_amount": 0,
"installments": 1,
"payment_method_type": "credit_card",
"settlement_days": 30
},
{
"id": "rate_unUh9iZu",
"card_brand": "visa",
"currency": "brl",
"fee_rate": 949,
"fixed_fee_amount": 0,
"installments": 12,
"payment_method_type": "credit_card",
"settlement_days": 30
},
{
"id": "rate_Z2oTNBYa",
"card_brand": null,
"currency": "brl",
"fee_rate": 0,
"fixed_fee_amount": 99,
"installments": 1,
"payment_method_type": "pix",
"settlement_days": 1
}
],
"updated_at": "2026-09-26T10:30:00Z"
}
],
"has_more": false,
"url": "/v1/fee-plans"
}
{
"error": {
"code": "invalid_request",
"message": "is_default must be true or false.",
"param": "is_default",
"type": "invalid_request_error"
}
}
{
"error": {
"code": "authentication_failed",
"message": "Unauthorized — invalid api key",
"type": "authentication_error"
}
}
{
"error": {
"code": "permission_denied",
"message": "Fee plans can only be read with a Chargefy for Platforms key.",
"type": "authentication_error"
}
}
Este endpoint só está disponível para contas com o produto Chargefy for
Platforms habilitado. Nesse produto, uma plataforma opera pagamentos para
suas organizações filhas.
fee_plan completo.
Use a API key da plataforma com escopo platform_admin e não envie o header
Organization. Enquanto as condições da sua plataforma não forem liberadas, a
lista vem vazia.
string
Cursor para retornar a página anterior. Use o
id do primeiro item da página
atual.boolean
true retorna só o plano padrão atual; false, os demais.integer
Quantidade de resultados, de 1 a 100. Padrão: 10.
string
Cursor para retornar a próxima página. Use o
id do último item da página
atual.curl -X GET "https://api.chargefy.io/v1/fee-plans?is_default=true" \
-H "Authorization: Bearer {{PLATFORM_API_KEY}}"
Resposta
200 OK com a lista. O exemplo abaixo é resumido: rates mostra 5 das 62
condições do plano.
{
"object": "list",
"data": [
{
"id": "plan_nVTh3XtU",
"object": "fee_plan",
"created_at": "2026-09-26T10:00:00Z",
"description": null,
"fee_calculation_base": "chargeable",
"installment_plan": "00349",
"is_default": true,
"livemode": true,
"metadata": {},
"name": "Padrão",
"prepaid": true,
"rates": [
{
"id": "rate_UbDhy9GD",
"card_brand": null,
"currency": "brl",
"fee_rate": 0,
"fixed_fee_amount": 349,
"installments": 1,
"payment_method_type": "boleto",
"settlement_days": 6
},
{
"id": "rate_PKj9TALF",
"card_brand": null,
"currency": "brl",
"fee_rate": 399,
"fixed_fee_amount": 0,
"installments": 1,
"payment_method_type": "credit_card",
"settlement_days": 30
},
{
"id": "rate_FHH9VpEY",
"card_brand": "visa",
"currency": "brl",
"fee_rate": 399,
"fixed_fee_amount": 0,
"installments": 1,
"payment_method_type": "credit_card",
"settlement_days": 30
},
{
"id": "rate_unUh9iZu",
"card_brand": "visa",
"currency": "brl",
"fee_rate": 949,
"fixed_fee_amount": 0,
"installments": 12,
"payment_method_type": "credit_card",
"settlement_days": 30
},
{
"id": "rate_Z2oTNBYa",
"card_brand": null,
"currency": "brl",
"fee_rate": 0,
"fixed_fee_amount": 99,
"installments": 1,
"payment_method_type": "pix",
"settlement_days": 1
}
],
"updated_at": "2026-09-26T10:30:00Z"
}
],
"has_more": false,
"url": "/v1/fee-plans"
}
{
"error": {
"code": "invalid_request",
"message": "is_default must be true or false.",
"param": "is_default",
"type": "invalid_request_error"
}
}
{
"error": {
"code": "authentication_failed",
"message": "Unauthorized — invalid api key",
"type": "authentication_error"
}
}
{
"error": {
"code": "permission_denied",
"message": "Fee plans can only be read with a Chargefy for Platforms key.",
"type": "authentication_error"
}
}
Erros
| Status | code | Quando |
|---|---|---|
400 | invalid_request | is_default diferente de true ou false, cursor inválido, os dois cursores na mesma chamada ou header Organization enviado. |
401 | authentication_failed | API key ausente, inválida, revogada ou expirada. |
403 | permission_denied | A API key não é de plataforma. |
405 | method_not_allowed | Método diferente de GET. Planos são criados e editados no painel. |
⌘I
curl -X GET "https://api.chargefy.io/v1/fee-plans?is_default=true" \
-H "Authorization: Bearer {{PLATFORM_API_KEY}}"
{
"object": "list",
"data": [
{
"id": "plan_nVTh3XtU",
"object": "fee_plan",
"created_at": "2026-09-26T10:00:00Z",
"description": null,
"fee_calculation_base": "chargeable",
"installment_plan": "00349",
"is_default": true,
"livemode": true,
"metadata": {},
"name": "Padrão",
"prepaid": true,
"rates": [
{
"id": "rate_UbDhy9GD",
"card_brand": null,
"currency": "brl",
"fee_rate": 0,
"fixed_fee_amount": 349,
"installments": 1,
"payment_method_type": "boleto",
"settlement_days": 6
},
{
"id": "rate_PKj9TALF",
"card_brand": null,
"currency": "brl",
"fee_rate": 399,
"fixed_fee_amount": 0,
"installments": 1,
"payment_method_type": "credit_card",
"settlement_days": 30
},
{
"id": "rate_FHH9VpEY",
"card_brand": "visa",
"currency": "brl",
"fee_rate": 399,
"fixed_fee_amount": 0,
"installments": 1,
"payment_method_type": "credit_card",
"settlement_days": 30
},
{
"id": "rate_unUh9iZu",
"card_brand": "visa",
"currency": "brl",
"fee_rate": 949,
"fixed_fee_amount": 0,
"installments": 12,
"payment_method_type": "credit_card",
"settlement_days": 30
},
{
"id": "rate_Z2oTNBYa",
"card_brand": null,
"currency": "brl",
"fee_rate": 0,
"fixed_fee_amount": 99,
"installments": 1,
"payment_method_type": "pix",
"settlement_days": 1
}
],
"updated_at": "2026-09-26T10:30:00Z"
}
],
"has_more": false,
"url": "/v1/fee-plans"
}
{
"error": {
"code": "invalid_request",
"message": "is_default must be true or false.",
"param": "is_default",
"type": "invalid_request_error"
}
}
{
"error": {
"code": "authentication_failed",
"message": "Unauthorized — invalid api key",
"type": "authentication_error"
}
}
{
"error": {
"code": "permission_denied",
"message": "Fee plans can only be read with a Chargefy for Platforms key.",
"type": "authentication_error"
}
}