API Reference

Criar assinatura a partir de um Plano

post
https://api.b2b.usezapay.com.br/v2/recurrence/subscriptions/
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

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

customer

Dados do cliente. Obrigatório caso o customer_id não seja informado.

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

integer
Defaults to 1

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

card

Detalhes do Cartão de crédito.

Token do cartão gerado pelo checkout.

string
required

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

Id externo.

Nome da assinatura.

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

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)

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

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

items

Itens do plano.

metadata

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

first_payment

Dados do primeiro pagamento (opcional).

payment_method_params

Parâmetros específicos do método de pagamento (opcional). Obrigatório quando payment_method=pix.

Responses

Updated 7 months ago

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago