Skip to main content
POST
cURL

Escopo

Request

Response

  • 201: Assinatura criada.
  • 200: Pedido já possui assinatura (retorna assinatura existente).

Pré-condições

  • O pedido informado deve existir.
  • O pedido deve ser do tipo subscription.
  • O pedido precisa ter oferta de assinatura.

Erros

  • 400: parent_order_id ausente.
  • 400: pedido não é de assinatura.
  • 400: pedido sem oferta, cliente, produto ou método de pagamento associado.
  • 404: pedido não encontrado ou não pertence à sua conta.

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.

Body

parent_order_id
string
required

Identificador do pedido pai usado para criar a assinatura

Response

amount
string<decimal>
required

Valor da Assinatura

Pattern: ^-?\d{0,8}(?:\.\d{0,2})?$
parent_order
string
required

Pedido de Origem da Assinatura

paymentMethod
string
required

Método de pagamento utilizado na Assinatura

customer
string
required
read-only
product
string
required

Produto vendido na Assinatura

offer
string
required

Oferta vendida na Assinatura

orders
string[]
required

Identificador único do pedido no sistema

createdAt
string<date-time>
required
read-only

Data e hora de criação

updatedAt
string<date-time>
required
read-only

Data e hora da última atualização

id
string

Identificador único da Assinatura no sistema

Maximum string length: 255
status
enum<string>

Status da Assinatura

  • active - Ativa
  • inactive - Inativa
  • canceled - Cancelada
  • expired - Expirada
  • paused - Pausada
  • trial - Em período de teste
Available options:
active,
inactive,
canceled,
expired,
paused,
trial
current_period
integer

Número da recorrência atual. (ex: 1 = primeiro pagamento)

Required range: -2147483648 <= x <= 2147483647
recurrence_period
integer

Quantidade de dias entre cada pagamento da assinatura

Required range: -2147483648 <= x <= 2147483647
quantity_recurrences
integer

Quantidade vezes que a assinatura será cobrada

Required range: -2147483648 <= x <= 2147483647
trial_days
integer

Quantidade de dias de teste gratuito da assinatura

Required range: -2147483648 <= x <= 2147483647
max_retries
integer

Quantidade máxima de retentativas de cobrança em caso de falha

Required range: -2147483648 <= x <= 2147483647
retry_interval
integer

Intervalo entre retentativas de cobrança (dias)

Required range: -2147483648 <= x <= 2147483647
paid_payments_quantity
integer

Quantidade de pagamentos pagos para esta assinatura

Required range: -2147483648 <= x <= 2147483647
retention
string

Quantidade de tempo que a assinatura permaneceu ativa

next_payment_date
string<date-time> | null

Data e hora estimada do próximo pagamento

canceledAt
string<date-time> | null

Data e hora em que a assinatura foi cancelada