Renova uma assinatura existente.

post https://app.vindi.com.br/api/v1/subscriptions/{id}/renew

O processo de renovação de assinaturas é automático. Utilize esse método para adiantar a renovação de uma assinatura.

Responses

Response body

object

int32

required

ID da assinatura

status

string

required

Status da assinatura

active canceled future expired

start_at

string

required

Data do início da assinatura no formato ISO 8601

end_at

string

Data do término da assinatura no formato ISO 8601

next_billing_at

string

Data da próxima cobrança da assinatura

overdue_since

string

Data do início da inadimplência

code

string

Código externo para referência via API

cancel_at

string

Data do cancelamento da assinatura

interval

string

required

Duração do intervalo

days months

interval_count

int32

required

Número de intervalos dentro de um período

billing_trigger_type

string

required

Referência para data de geração da cobrança

beginning_of_period end_of_period day_of_month

billing_trigger_day

int32

required

Dia para geração da cobrança.

billing_cycles

int32

Número máximo de períodos da assinatura. Nulo significa duração indefinida

installments

int32

required

Número de parcelas

created_at

string

required

Data e hora do cadastro da assinatura

updated_at

string

required

Data e hora da última atualização da assinatura

customer

object

required

int32

required

ID do cliente

name

string

required

Nome do cliente

string

E-mail do cliente

code

string

Código opcional para referência via API

plan

object

required

int32

required

ID do plano

name

string

required

Nome do plano

code

string

Código externo do plano

product_items

array of objects

required

Produtos incluídos na assinatura. Este atributo exibe os primeiros 25 itens. Para os demais, consulte o método GET /subscriptions/:id/product_items.

product_items*

object

int32

required

ID do item

status

string

required

Status do item

active inactive deleted

uses

int32

Número de ciclos de recorrência que utilizaram o produto.

cycles

int32

Número de ciclos de recorrência onde o produto será aplicado a partir do momento de sua criação. Nulo significa duração ilimitada

quantity

int32

Quantidade do produto incluído na assinatura. Se não for informado, o valor '1' será utilizado

created_at

string

required

Data e hora da criação do item

updated_at

string

required

Data e hora da última atualização do item

product

object

required

pricing_schema

object

discounts

array of objects

Lista de descontos ativos. Descontos já aplicados não serão retornados

discounts

object

int32

required

ID do desconto

discount_type

string

required

Tipo do desconto

percentage amount quantity

percentage

number

Valor numérico para porcentagem de 0.01 até 100

amount

number

Valor para desconto fixo

quantity

int32

Número para desconto por quantidade

cycles

int32

Número de ciclos de recorrência onde o desconto será aplicado a partir do momento de sua criação. Nulo significa desconto por tempo indefinido

payment_method

object

required

int32

required

ID do método de pagamento

public_name

string

required

Nome público do método de pagamento

name

string

required

Nome interno do método de pagamento

code

string

required

Código externo para referência via API

type

string

required

Tipo do método de pagamento

current_period

object

int32

required

ID do período

billing_at

string

Data para geração automática da cobrança do período

cycle

int32

required

Ciclo do período

start_at

string

required

Data e hora do início do período

end_at

string

required

Data e hora do término do período

duration

int32

required

Duração do período em número de segundos

metadata

object

Metadados da assinatura

payment_profile

object

int32

required

ID do perfil de pagamento

holder_name

string

Nome do titular/portador do perfil de pagamento

registry_code

string

CPF ou CNPJ do titular/portador

bank_branch

string

Agência da conta bancária

bank_account

string

Número da conta bancária

card_expiration

string

Validade do cartão de crédito no formato MM/AA

allow_as_fallback

string

Permite utilizar o perfil de pagamento em retentativas de cobranças não pagas.

card_number_first_six

string

Primeiros 6 dígitos do cartão de crédito (BIN/IIN)

card_number_last_four

string

Últimos 4 dígitos do cartão de crédito

renewed_card

object

card_renewed_at

string

Data da renovação do cartão de crédito renovado

token

string

required

Token interno para referência do perfil de pagamento

created_at

string

required

Data e hora do cadastro do perfil de pagamento

payment_company

object

required

invoice_split

string

Nota fiscal fracionada. Indica se uma nota fiscal será emitida de acordo com a periodicidade do plano.

subscription_affiliates

array of objects

Lista de participantes da assinatura. Este campo é exclusivo para transaçõesque utilizaram a regra de split de pagamento e os participantes estejam ativos.

subscription_affiliates

object

affiliate_id

int32

ID do participante

amount

number

Fração do valor da assinatura referente ao participante

amount_type

int32

Tipo de valor da assinatura, onde 1 representa uma quantia fixa (amount) e 2 representa a porcentagem (percentage)

status

string

Status do participante em uma assinatura

Language

Credentials

Basic

base64

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://app.vindi.com.br/api/v1/subscriptions/id/renew \
3
     --header 'accept: application/json'


xxxxxxxxxx
120
}
1
{
2
  "id": 0,
3
  "status": "active",
4
  "start_at": "string",
5
  "end_at": "string",
6
  "next_billing_at": "string",
7
  "overdue_since": "string",
8
  "code": "string",
9
  "cancel_at": "string",
10
  "interval": "days",
11
  "interval_count": 0,
12
  "billing_trigger_type": "beginning_of_period",
13
  "billing_trigger_day": 0,
14
  "billing_cycles": 0,
15
  "installments": 0,
16
  "created_at": "string",
17
  "updated_at": "string",
18
  "customer": {
19
    "id": 0,
20
    "name": "string",
21
    "email": "string",
22
    "code": "string"
23
  },
24
  "plan": {
25
    "id": 0,

200Assinatura renovada com sucesso.

400Erro de sintaxe JSON no corpo do request.

404Assinatura não encontrada.

422Parâmetros inválidos. Verificar erro na resposta.