Encontrar todos os planos atrelados ao seller

GET 
/recurrency/plans

Este endpoint é utilizado para recuperar todos os planos de assinatura disponíveis. Ao acessar este endpoint, o sistema retorna uma lista de todos os planos de assinatura disponíveis, juntamente com seus detalhes, como nome, descrição, preço, duração e recursos incluídos.

Request

Responses

200

OK

application/json

Schema

Schema

plans

object[]

Array [

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)

{
  "plans": [
    {
      "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...