Saltar al contenido principal
PATCH
Update an account plan

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

organization_id
string
requerido

Organization ID (UUID)

ledger_id
string
requerido

Ledger ID (UUID)

account_plan_id
string
requerido

Account plan ID (UUID)

Cuerpo

application/json
description
string | null
Ejemplo:

"Essential plan for individuals"

effectiveFrom
string | null

RFC 3339 instant the new version applies from, only with fees. Defaults to the request instant; must not precede the effectiveFrom of the latest version.

Ejemplo:

"2026-11-01T03:00:00Z"

enable
boolean | null
Ejemplo:

true

fees
object

Fee patches keyed by fee key. An entry naming a stored key replaces the fields it sets on that fee, or removes the fee when it sets no field. Any other key adds a fee and must carry every required field. Sending fees creates a new plan version with the full resulting fee map.

label
string | null
Ejemplo:

"Essential PF"

timezone
string | null
Ejemplo:

"America/Sao_Paulo"

Respuesta

OK

createdAt
string<date-time>
requerido
Ejemplo:

"2026-01-01T00:00:00Z"

currentVersion
integer<int64>
requerido

Highest version created for the plan.

Ejemplo:

1

effectiveFrom
string<date-time>
requerido

Instant the version in effect applies from.

Ejemplo:

"2026-01-01T00:00:00Z"

enable
boolean
requerido

Whether new accounts can be assigned to the plan. Disabling it keeps charging the accounts already assigned.

Ejemplo:

true

fees
object
requerido

Fees of the version in effect, keyed by fee key.

id
string
requerido
Ejemplo:

"00000000-0000-0000-0000-000000000000"

label
string
requerido

Plan name, unique among the ledger's plans that are not deleted.

Ejemplo:

"Essential PF"

ledgerId
string
requerido
Ejemplo:

"00000000-0000-0000-0000-000000000000"

organizationId
string
requerido
Ejemplo:

"00000000-0000-0000-0000-000000000000"

timezone
string
requerido

IANA timezone the monthly free quota is counted in. Defaults to America/Sao_Paulo.

Ejemplo:

"America/Sao_Paulo"

updatedAt
string<date-time>
requerido
Ejemplo:

"2026-01-01T00:00:00Z"

version
integer<int64>
requerido

Version in effect at the instant of the read.

Ejemplo:

1

deletedAt
string<date-time>
Ejemplo:

"2026-01-01T00:00:00Z"

description
string
Ejemplo:

"Essential plan for individuals"