Skip to main content
PUT
/
public_api
/
offers
/
{id}
cURL
curl --request PUT \
  --url https://api.cakto.com.br/public_api/offers/{id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "price": 123,
  "image": "<string>",
  "units": 2,
  "status": "active",
  "type": "unique",
  "intervalType": "week",
  "interval": 123,
  "recurrence_period": 123,
  "quantity_recurrences": 123,
  "trial_days": 123,
  "max_retries": 123,
  "retry_interval": 123
}
'
{
  "id": "5Hrb526",
  "name": "Nome da Oferta",
  "image": "https://example.com/image.png",
  "price": 5,
  "units": 1,
  "default": true,
  "product": "fb3fda61-e88f-43b5-982a-32d50f112414",
  "status": "active",
  "type": "unique",
  "intervalType": "week",
  "interval": 1,
  "recurrence_period": 30,
  "quantity_recurrences": -1,
  "trial_days": 0,
  "max_retries": 3,
  "retry_interval": 1
}

​
Escopo

    write offers

Authorizations

​
Authorization
string
header
required

Token de autenticação do tipo Bearer {access_token}, onde {access_token} é o token obtido no fluxo de autenticação.

Path Parameters

​
id
string
required

Id da Oferta

Body

​
name
string
required

Nome da oferta, exibido no checkout e em outros locais

Maximum string length: 255
​
price
number<double>
required

Preço da oferta

​
image
string<uri> | null

Imagem que poderá aparecer em vários locais, como checkout, opções do produto, etc.

​
units
integer

Número de unidades que o cliente irá adquirir ao comprar esta oferta.

Required range: x >= 1
​
status
enum<string>

Status atual da oferta

  • active - Ativo
  • disabled - Desabilitado
  • deleted - Deletado
Available options:
active,
disabled,
deleted
​
type
enum<string>

Tipo de pagamento da oferta (ex: unique, subscription)

  • unique - Pagamento único
  • subscription - Assinatura recorrente
Available options:
unique,
subscription
​
intervalType
enum<string>

Tipo de intervalo do acesso concedido pela oferta (ex: month, week, lifetime)

  • week - Semana
  • month - Mês
  • year - Ano
  • lifetime - Vitalício
Available options:
week,
month,
year,
lifetime
​
interval
integer

Número de intervalos que serão concedidos ao comprar esta oferta. Ex: interval=2 e intervalType=month concede 2 meses de acesso.

​
recurrence_period
integer

Número de dias entre cada cobrança da assinatura

​
quantity_recurrences
integer

Número de cobranças que serão feitas na assinatura. Use -1 para cobranças ilimitadas.

​
trial_days
integer

Número de dias de teste grátis antes da primeira cobrança

​
max_retries
integer

Número máximo de retentativas de cobrança em caso de falha no pagamento

​
retry_interval
integer

Número de dias entre cada retentativa de cobrança

Response

Corpo da resposta status 200

​
id
string
required

Identificador único da oferta

​
name
string
required

Nome da oferta, exibido no checkout e em outros locais

Maximum string length: 255
​
price
number<double>
required

Preço da oferta

​
default
boolean
required

Indica se esta é a oferta padrão do produto

​
product
string
required

Produto ao qual esta oferta pertence

​
image
string<uri> | null

Imagem que poderá aparecer em vários locais, como checkout, opções do produto, etc.

​
units
integer

Número de unidades que o cliente irá adquirir ao comprar esta oferta.

Required range: x >= 1
​
status
enum<string>

Status atual da oferta

  • active - Ativo
  • disabled - Desabilitado
  • deleted - Deletado
Available options:
active,
disabled,
deleted
​
type
enum<string>

Tipo de pagamento da oferta (ex: unique, subscription)

  • unique - Pagamento único
  • subscription - Assinatura recorrente
Available options:
unique,
subscription
​
intervalType
enum<string>

Tipo de intervalo do acesso concedido pela oferta (ex: month, week, lifetime)

  • week - Semana
  • month - Mês
  • year - Ano
  • lifetime - Vitalício
Available options:
week,
month,
year,
lifetime
​
interval
integer

Número de intervalos que serão concedidos ao comprar esta oferta. Ex: interval=2 e intervalType=month concede 2 meses de acesso.

​
recurrence_period
integer

Número de dias entre cada cobrança da assinatura

​
quantity_recurrences
integer

Número de cobranças que serão feitas na assinatura. Use -1 para cobranças ilimitadas.

​
trial_days
integer

Número de dias de teste grátis antes da primeira cobrança

​
max_retries
integer

Número máximo de retentativas de cobrança em caso de falha no pagamento

​
retry_interval
integer

Número de dias entre cada retentativa de cobrança