Sign in

v1

latestOpenAPI 3.0.32026-07-2647114182.1 KB
offers

Public API for managing offers, inherits from OfferAPIView, customizes the schema generation and authentication/permission settings.

get/public_api/offers/{id}/

Path parameters

idstring required

Id da Oferta

Response

Corpo da resposta status 200

idstring required

Identificador único da oferta

namestring required

Nome da oferta, exibido no checkout e em outros locais

imagestring uri nullable

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

pricenumber double required

Preço da oferta

unitsinteger

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

defaultboolean required

Indica se esta é a oferta padrão do produto

productstring required

Produto ao qual esta oferta pertence

status'active' | 'disabled' | 'deleted'
  • active - Ativo
  • disabled - Desabilitado
  • deleted - Deletado
type'unique' | 'subscription'
  • unique - Pagamento único
  • subscription - Assinatura recorrente
intervalType'week' | 'month' | 'year' | 'lifetime'
  • week - Semana
  • month - Mês
  • year - Ano
  • lifetime - Vitalício
intervalinteger

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

recurrence_periodinteger

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

quantity_recurrencesinteger

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

trial_daysinteger

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

max_retriesinteger

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

retry_intervalinteger

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