Skip to main content
PUT
Replace credit package

Autorizações

X-Api-Key
string
header
obrigatório

Parâmetros de caminho

creditPackagePublicId
string<uuid>
obrigatório

Corpo

application/json

Body for fully replacing an existing credit package. All required fields must be present (PUT semantics).

creditValueCents
integer<int32>
obrigatório

Price per credit in the smallest currency unit (cents).

Intervalo necessário: x >= 1
Exemplo:

5

creditsAmount
integer<int32>
obrigatório

Number of credits included in the package.

Intervalo necessário: x >= 1
Exemplo:

1000

extraCreditsAmount
integer<int32>

Optional bonus credits added on top of creditsAmount.

Intervalo necessário: x >= 1
Exemplo:

100

name
string

Display name of the credit package.

Required string length: 1 - 100
Exemplo:

"Starter pack"

renewalIntervalMonths
integer<int32>

Renewal interval in months. Omit for one-time / non-renewable packages.

Exemplo:

1

Resposta

OK

createdAt
string<date-time>
creditValueCents
integer<int32>
creditsAmount
integer<int32>
extraCreditsAmount
integer<int32>
name
string
publicId
string<uuid>
renewalIntervalMonths
integer<int32>
updatedAt
string<date-time>