Atualização de um plano existente

PUT 
/recurrency/plans/:planId

Este endpoint é utilizado para atualizar os detalhes de um plano de assinatura existente com base no ID fornecido. Os planos de assinatura podem precisar ser atualizados para refletir alterações nos termos, preços, benefícios ou outros atributos associados ao plano. Ao enviar uma solicitação de atualização para este endpoint, os detalhes pertinentes do plano, como o nome, a descrição, o preço, a duração e os recursos, devem ser fornecidos no corpo da solicitação. O ID do plano a ser atualizado deve ser especificado na URL. Após a atualização bem-sucedida, o sistema retorna os detalhes atualizados do plano.

Request

Path Parameters

planId uuidrequired
Example: 8086bfd7-6241-4f76-81d8-70460533ce74

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...