Pular para o conteúdo principal
GET
Get an account plan

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

organization_id
string
obrigatório

Organization ID (UUID)

ledger_id
string
obrigatório

Ledger ID (UUID)

account_plan_id
string
obrigatório

Account plan ID (UUID)

Resposta

OK

createdAt
string<date-time>
obrigatório
Exemplo:

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

currentVersion
integer<int64>
obrigatório

Highest version created for the plan.

Exemplo:

1

effectiveFrom
string<date-time>
obrigatório

Instant the version in effect applies from.

Exemplo:

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

enable
boolean
obrigatório

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

Exemplo:

true

fees
object
obrigatório

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

id
string
obrigatório
Exemplo:

"00000000-0000-0000-0000-000000000000"

label
string
obrigatório

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

Exemplo:

"Essential PF"

ledgerId
string
obrigatório
Exemplo:

"00000000-0000-0000-0000-000000000000"

organizationId
string
obrigatório
Exemplo:

"00000000-0000-0000-0000-000000000000"

timezone
string
obrigatório

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

Exemplo:

"America/Sao_Paulo"

updatedAt
string<date-time>
obrigatório
Exemplo:

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

version
integer<int64>
obrigatório

Version in effect at the instant of the read.

Exemplo:

1

deletedAt
string<date-time>
Exemplo:

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

description
string
Exemplo:

"Essential plan for individuals"