Criar novo plano

Cria um novo plano que será utilizado no fluxo de pagamentos recorrente. O plano define as configurações para as assinaturas que farão parte dele, como valor, periodicidade, métodos aceitos e outras.

application/json

Request Body required

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

name string required

O nome do plano.

methods PaymentMethods[] required

Possible values: [credit, billet, pix]

Os métodos de pagamento que serão aceitos neste plano.

value number required

O valor do plano em centavos.

status PlanStatus

Possible values: [active, inactive]

O status do plano.

interval number required

O intervalo, ou seja, a periodicidade de cobrança do plano. Por exemplo, para cobrar a cada mês o intervalo é 1.

interval_type PlanIntervals required

Possible values: [days, months, years]

O tipo de ciclo que será usado na contagem dos intervalos. Podendo ser dias, meses ou anos. Por exemplo, para cobrar mensalmente defina interval como 1 e interval_type como months

dunning_id number required

Essa configuração se refere a régua de cobrança que será usada para enviar comunicações sobre as assinaturas criadas com este plano. Para testes utilize o valor 1 (régua padrão)

Responses

• 200
• 401
• 422
• 500

---

Plano criado com sucesso

application/json

Schema

Example (from schema)

---

Schema

id integer

O id do plano na NinePay.

name string

O nome do plano.

methods PaymentMethods[]

Possible values: [credit, billet, pix]

Os métodos de pagamento que são aceitos neste plano.

value number

O valor do plano em centavos.

interval number

O intervalo, ou seja, a periodicidade de cobrança do plano. Por exemplo, para cobrar a cada mês o intervalo é 1.

interval_type PlanIntervals

Possible values: [days, months, years]

O tipo de ciclo que será usado na contagem dos intervalos. Podendo ser dias, meses ou anos. Por exemplo, para cobrar mensalmente defina interval como 1 e interval_type como months

dunning_id number

A régua de cobrança que será usada para enviar comunicações sobre as assinaturas criadas com este plano.

created_at date-time

Data de criação

{
  "id": 42,
  "name": "Plano Recorrente Acme",
  "methods": [
    "credit"
  ],
  "value": 2500,
  "interval": 1,
  "interval_type": "months",
  "dunning_id": 1,
  "created_at": "2017-07-21 05:20:00"
}

Não autorizado

application/json

Schema

Example (from schema)

Example

---

Schema

message string required

{
  "message": "string"
}

{
  "message": "Unauthenticated"
}

Erro na validação de dados

application/json

Schema

Example (from schema)

Example

---

Schema

message string required
errors object
property name* string

{
  "message": "string",
  "errors": {}
}

{
  "message": "The given data was invalid.",
  "errors": {
    "name": "The name field is required."
  }
}

Houve um erro inesperado

application/json

Schema

Example (from schema)

Example

---

Schema

message string required

{
  "message": "string"
}

{
  "message": "An unexpected error occurred"
}

Loading...