Atributos
Esse objeto representa uma assinatura que pode ser associada a um cliente.
id string
O identificador exclusivo da assinatura (MAX 64; MIN 36).
Example: 7304911d-5df9-429e-8488-ad41abea1a4c
name string
O nome da assinatura (MAX 255; MIN 3).
Exemplo: sub_001
description string
A descrição da assinatura (MAX 255; MIN 3).
Exemplo: Serviço de streaming
account_id string
O identificador exclusivo da conta que terá o plano de
plano de assinatura disponível para uso (MAX 64; MIN 36).
Example: 2404911d-5df9-429e-8488-ad41abea1a4b
merchant_reference string
Identificação do plano de assinatura (MAX 255;
MIN 3).
Exemplo: 001_marzo_23
country string
O país da assinatura.
Exemplo:
CO
status enum
Status da assinatura.
Valores possíveis:
ACTIVE=A assinatura foi criada com um cliente associado e já está ativa.PAUSED=A assinatura foi pausada e pode ser reativada.COMPLETED=A assinatura foi concluída porque atingiu a data e a hora de término.CANCELED=Subscrição cancelada.
amount objeto
Especifica o objeto de valor da assinatura, com o valor e a moeda.
currency enum
A moeda usada para fazer o payment (MAX 3; MIN 3; ISO 4217).
Possíveis valores de enum: Verifique a referência do país.
value número
O valor payment (múltiplo de 0,0001).
Exemplo: 12100,00
frequency objeto
A frequência definida para a assinatura de pagamento.
Se não for definida, os padrões são MONTH para o tipo e 1 para o valor.
Se não for definida, os padrões são MONTH para o tipo e 1 para o valor.
type enum
O tipo de intervalo que a assinatura terá no tempo (DIA,
SEMANA, MÊS). Se não for definido, será sempre MÊS por padrão.
Valores de enum possíveis: DAY, MONTHou YEAR.
value int
O valor entre cada intervalo que a assinatura terá
no tempo. Se não for definido, será sempre 1 por padrão.
Exemplo: 1
billing_cycles objeto
Especifica o objeto billing_cycles.
total número
Quantidade total de ciclos de faturamento.
Exemplo:
10
current número
Valor do ciclo de faturamento atual.
Exemplo: 2
next_at Carimbo de data/hora
A data do próximo pagamento da assinatura.
Example: 2023-02-16T20:00:00.786342Z
billing_date objeto
[Opcional] Especifica o objeto billing_date. Mutuamente exclusivo com o objeto frequency.
type número
O tipo de billing_date que a assinatura terá em
tempo. PREPAID, POSTDATE, DAY. Se não for definida, a data de criação do plano será definida por padrão.
Exemplo:
DATA_DE_CRIAÇÃO_DO_PLANO
day número
O dia do mês para cobrar a assinatura se o tipo
estiver definido como DAY. Sempre 1 por padrão.
Exemplo: 2
customer_payer objeto
Especifica o objeto customer_payer.
id* string
O identificador exclusivo do cliente (MAX 255; MIN 3).
Exemplo: 3t04911d-5df9-429e-8488-ad41abea1a2c
payment_method matriz de objetos
Especifica o objeto payment.
type enum
Tipo do método de pagamento.
Possíveis valores de enum
valores: CARD
token string
O token de método de pagamento de uso único fornecido pelo Yuno SDK
(MÁXIMO 64; MÍNIMO 36).
Example: 9104911d-5df9-429e-8488-ad41abea1a4b
vaulted_token string
O token armazenado do método de pagamento armazenado
(MÁXIMO: 64; MÍNIMO: 36).
Example: 6104911d-5df9-429e-8488-ad41abea1a4b
card objeto
Especifica o objeto do cartão.
verify booleano
Usando amount = 0 e verify = true, você pode verificar o cartão do usuário
o cartão do usuário sem autorizar um valor real.
Valores possíveis: ture ou
false.
card_data objeto
Especifica o objeto card_data.
number string
Número do cartão sem nenhum separador (MAX 19;
MIN 8) - disponível apenas para comerciantes certificados pela PCI.
Exemplo: 4507990000000010
expiration_month número
Mês de validade do cartão - MM (MAX 2;
MIN 2) - disponível apenas para comerciantes certificados pela PCI.
Exemplo: 10
expiration_year número
Ano de validade do cartão - YYYY (MAX 4;
MIN 4) - disponível apenas para comerciantes certificados pela PCI.
Exemplo: 2025
security_code número
Código de segurança do cartão (MAX 4; MIN 3) - disponível apenas
disponível para comerciantes certificados pelo PCI.
Exemplo: 123
holder_name string
Nome completo do titular do cartão como aparece no
Cartão (MÁX 26; MÍN 3) - disponível apenas para comerciantes certificados pela PCI.
Exemplo: JOHN
DOE
trial_period objeto
Especifica o objeto trial_period.
billing_cycles número
Quantidade total de ciclos de faturamento aos quais o free_trial
deve ser aplicado.
Exemplo:
1
amount objeto
Valor a ser descontado no período de teste.
currency string
A moeda usada para fazer o período de avaliação. (ISO
4217 MAX 3; MIN 3).
Exemplo: COP
value número
Mês de validade do cartão - MM (MAX 2;
MIN 2) - disponível apenas para comerciantes certificados pela PCI.
Exemplo: 10
availability objeto
Especifica o objeto de disponibilidade. As datas em que a assinatura estará disponível. Se for nula, a data de início
será o dia da criação e não terá uma data de término.
start_at Carimbo de data/hora
A data de início em que a assinatura estará
disponível para uso.
Example: 2024-01-16T00:00:00.786342Z
finish_at Carimbo de data/hora
A data final até a qual a assinatura estará
disponível para uso.
Example: 2024-05-26T20:00:00.786342Z
retries objeto
Especifica o objeto de novas tentativas. Se precisarmos tentar novamente transações recusadas no Yuno e o valor, se necessário.
retry_on_decline bool
Se devemos tentar novamente um pagamento ou não após uma primeira recusa. Falso por padrão.
Exemplo: VERDADEIRO
amount número
O número de novas tentativas que o plano de assinatura terá até a conclusão. Se não for definido, ou se for maior que 7, 7
será definido como padrão. Máximo: 7
Exemplo: 4
initial_payment_validation bool
Sinalizador para identificar se a assinatura deve
aguardar o primeiro pagamento para continuar. Falso por padrão.
MIN 27).
Exemplo: false
metadata objeto
Especifica o objeto de metadados.
key string
Este valor serve como nome ou identificador para os metadados. Use um termo descritivo. (MÁX. 48; MÍN. 1).
Exemplo: sub_ext_id
value string
As informações que você deseja armazenar nos metadados. (MÁX. 512; MÍN. 1).
Exemplo: AA001
payments Matriz de cadeias de caracteres
Especifica a matriz de pagamentos.
id* string
O identificador exclusivo do pagamento (MAX 64; MIN 36).
Exemplo: 5104911d-5df9-229e-8468-bd41abea1a4s
created_at Carimbo de data/hora
Data e hora de criação da assinatura (ISO 8601 MAX 27;
MIN 27).
Example: 2023-12-16T20:46:54.786342Z
updated_at Carimbo de data/hora
Data e hora da última atualização da assinatura (ISO 8601 MAX
27; MIN 27).
Example: 2023-12-16T21:00:54.786342Z
additional_data objeto
Especifica o objeto additional_data. Esse objeto não é obrigatório. No entanto, se você enviar essas informações, a experiência de
experiência payment será aprimorada para o seu usuário.
order objeto
Especifica o objeto de pedido.
items matriz de objetos
Especifica o objeto do item.
id string
O identificador exclusivo do item (MAX 255; MIN 3).
Exemplo: 3214
name string
O nome do item (MAX 255; MIN 3).
Exemplo: iPhone 12 Pro Max
quantity int
A quantidade do item (MAX 999; MIN 1).
Exemplo: 1
unit_amount flutuar
O valor unitário do item (múltiplo de 0,0001).
Exemplo: 550
category string
A categoria do item (MAX 255; MIN 3).
Valores possíveis: Verificar a lista de categorias do item.
brand string
A marca do item (MAX 255; MIN 3).
Exemplo: Apple
sku_code string
A unidade de manutenção de estoque (SKU) do item (MAX 255; MIN 3).
Exemplo: A2342
manufacture_part_number string
O número da peça de fabricação do item (MAX 255; MIN 3).
Exemplo: 345621234