Criação de um novo plano

POST 
/recurrency/plans

Este endpoint é utilizado para criar novos planos de assinatura. Os planos de assinatura definem os termos, preços e benefícios associados a diferentes níveis de serviço oferecidos aos clientes. Ao criar um novo plano, os detalhes pertinentes, como o nome do plano, a descrição, o preço, a duração e quaisquer outros atributos relevantes, devem ser fornecidos no corpo da solicitação. Após a criação bem-sucedida, o sistema retorna os detalhes completos do plano recém-criado, incluindo um identificador único para referência futura.

Request

application/json

Body

required

billingCycle stringrequired

Possible values: [DAILY, WEEKLY, MONTHLY, QUARTERLY, BIANNUAL, ANNUAL]

amount int32required

Possible values: >= 1

totalBillingCycles int32required

Possible values: >= 1

initialGraceCycles int32

initialFee

object

description stringrequired

amount int32required

cycles int32required

Possible values: >= 1

tag stringrequired

Possible values: non-empty

Responses

200

OK

application/json

Schema

Schema

id string
billingCycle string
totalBillingCycles int32
initialGraceCycles int32

initialFee

object

description string

amount int32

cycles int32
tag string
paymentType string
amount int32
enabled boolean

Indica se o plano esta habilitado ou não.

Example (from schema)

{
  "id": "string",
  "billingCycle": "string",
  "totalBillingCycles": 0,
  "initialGraceCycles": 0,
  "initialFee": {
    "description": "Fee test description",
    "amount": 25,
    "cycles": 10
  },
  "tag": "string",
  "paymentType": "string",
  "amount": 15,
  "enabled": false
}

400

Bad Request

application/json

Schema

Schema

message stringrequired
success booleanrequired

errors

object[]

Array [

message string

field string

]

Example (from schema)

{
  "message": "string",
  "success": true,
  "errors": [
    {
      "message": "must be a well-formed UUID string",
      "field": "merchantChargeId"
    }
  ]
}

401

Unauthorized

application/json

Schema

Schema

message stringrequired
success booleanrequired

errors

object[]

Array [

message string

field string

]

Example (from schema)

{
  "message": "string",
  "success": true,
  "errors": [
    {
      "message": "must be a well-formed UUID string",
      "field": "merchantChargeId"
    }
  ]
}

Example

{
  "message": "Authorization token not found.",
  "success": false,
  "errors": {
    "message": "Authorization token not found",
    "field": "Authorization Token"
  }
}

415

Unsupported Media Type

application/json

Schema

Schema

message stringrequired
success booleanrequired

errors

object[]

Array [

message string

field string

]

Example (from schema)

{
  "message": "string",
  "success": true,
  "errors": [
    {
      "message": "must be a well-formed UUID string",
      "field": "merchantChargeId"
    }
  ]
}

Example

{
  "message": "Request object is invalid or incorrectly formatted",
  "success": false,
  "errors": null
}

500

Internal Server Error

application/json

Schema

Schema

message stringrequired
success booleanrequired

errors

object[]

Array [

message string

field string

]

Example (from schema)

{
  "message": "string",
  "success": true,
  "errors": [
    {
      "message": "must be a well-formed UUID string",
      "field": "merchantChargeId"
    }
  ]
}

Example

{
  "message": "Internal Server Error",
  "success": false,
  "errors": null
}

Loading...