Skip to main content
GET
Consulta a versão corrente da regra de comissão

Authorizations

Authorization
string
header
required

Chave de API (prefixo rstr_) enviada como Authorization: Bearer rstr_....

Path Parameters

programId
string
required
Pattern: ^prog_[0-9A-HJKMNP-TV-Z]{26}$

Response

200 - application/json

Default Response

id
string
required

Identificador único da regra de comissão (prefixo comm_ + ULID).

Example:

"comm_01J9ZK8QF3N2P5R7T9V1W3X5Y7"

programId
string
required

Identificador do programa ao qual a regra pertence.

Example:

"prog_01J9ZK8QF3N2P5R7T9V1W3X5Y7"

version
integer
required

Versão da regra. Cada alteração cria uma nova versão (regras são imutáveis).

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

1

programTierId
string | null
required

Dono da regra: null = regra padrão do programa; preenchido = histórico próprio do tier (prefixo tier_ + ULID).

Pattern: ^tier_[0-9A-HJKMNP-TV-Z]{26}$
Example:

null

type
enum<string>
required

Tipo da regra: percentage (percentual sobre a venda), fixed (valor fixo por conversão) ou tiered (faixas por volume).

Available options:
percentage,
fixed,
tiered
Example:

"percentage"

percentage
number | null
required

Percentual de comissão (apenas para regras percentage).

Required range: 0 <= x <= 100Must be a multiple of 0.01
Example:

15

fixedAmountCents
integer | null
required

Valor fixo em centavos (apenas para regras fixed).

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

1990

recurrence
object
required

Política de recorrência da comissão.

tiers
object[] | null
required

Faixas de comissão (apenas para regras tiered).

applicableProductIds
string[] | null
required

IDs dos produtos aos quais a regra se aplica (null = todos).

createdAt
string<date-time>
required

Data de criação desta versão da regra (ISO-8601).

Example:

"2026-06-13T12:00:00.000Z"