Pular para o conteúdo principal

Criar nova assinatura​

Cria uma nova assinatura, que representa uma cobrança recorrente, vinculando um cliente a um plano específico.

Request Body required

Descreve os dados a serem incluídos no corpo da requisição.

    customer object required
    id number required

    O ID do cliente na NinePay. Se você ainda não tem o ID do cliente, utilize o endpoint de criação de Cliente para fazer o cadastro e receber o ID.

    plan object required
    id number required

    O ID do plano a que a nova assinatura será vinculada.

    coupon_codes string[]
Responses

Assinatura criada com sucesso

Schema
    subscription object
    id integer

    O id da assinatura.

    uuid uuid

    O id publico da assinatura. Esse id pode ser usado para levar o cliente a página de checkout para pagamento.

    amount number

    O valor da assinatura em centavos.

    plan_id number

    O id do plano.

    status SubscriptionStatus

    Possible values: [new, trial, active, overdue, canceled, expired, paused]

    O status da assinatura.

    created_at date-time

    Data de criação.

    customer object
    id integer required

    O id do cliente na NinePay. Obrigatório se os demais dados do usuário não forem informados

    name string required

    O nome do cliente. Obrigatório se o id não for informado

    email string required

    O email do cliente. Obrigatório se o id não for informado

    cpf string required

    O cpf do cliente. Obrigatório se o id ou o cnpj não forem informados

    cnpj string required

    O cnpj do cliente. Obrigatório se o id ou o cpf não forem informados

    phone string

    O telefone do cliente

    cep string

    O CEP do cliente

    address string

    O endereço do cliente

    number string

    O endereço do cliente

    district string

    O bairro do cliente

    city string

    A cidade do cliente

    state string

    O estado do cliente

    country string

    O código do país do cliente, no formato Alpha 2 de acordo com a ISO 3166.

Loading...