USusezapay
Assinaturas

Criar assinatura a partir de um Plano

post/recurrence/subscriptions/

Request

Request body

plan_idstring nullable

Id do Plano. Obrigatório se for uma assinatura de plano.

customer_idstring nullable

Id do cliente. Obrigatório caso o customer não seja informado.

installmentsinteger

Quantidade de parcelas aplicáveis quando o método de pagamento da assinatura for cartão de crédito.

card_tokenstring nullable

Token do cartão gerado pelo checkout.

payment_methodstring required

Meio de pagamento. Valores possíveis: credit_card, boleto, voucher e pix.

external_idstring nullable

Id externo.

namestring nullable

Nome da assinatura.

intervalstring nullable

Frequência da recorrência. Valores possíveis: day, week, month ou year.

interval_countinteger nullable

Número de intervalos de acordo com a propriedade interval entre cada cobrança da assinatura. Ex.: plano mensal = interval_count (1) e interval (month) plano trimestral = interval_count (3) e interval (month) plano semestral = interval_count (6) e interval (month)

interval_freeinteger nullable

Número de intervalo no qual a cobrança é gratuita. Ex.: interval_free (1) e interval (month) a primeira cobrança é gratuita.

billing_typestring nullable

Tipo de cobrança. Valores possíveis: prepaid, postpaid ou exact_day.

metadataobject nullable

Objeto chave/valor utilizado para armazenar informações adicionais sobre o pagamento

Response

Assinatura criada com sucesso

subscription_idstring required

Id da assinatura.

payment_methodstring required

Meio de pagamento utilizado na assinatura.

interval_countinteger required

Número de intervalos de acordo com a propriedade interval entre cada cobrança da assinatura. Ex.: plano mensal = interval_count (1)

plan_idstring nullable

Id do plano assinado.

billing_typestring required
next_billing_atstring date-time

Data do próximo faturamento da assinatura.

installmentsinteger nullable

Quantidade de parcelas aplicádas ao cartão de crédito.

external_idstring nullable

Id externo.

statusstring
created_atstring date-time required

Data de criação da assinatura.

updated_atstring date-time required

Data de atualização da assinatura.

metadataobject nullable

Dados adicionais da assinatura.

Changes

No recorded changes to this operation across all 1 revision of this API.