Obter detalhes do plano

Retorna os detalhes de um plano específico, com base no ID fornecido. Nota: É necessário fornecer o ID do plano para obter os detalhes.

Responses

• 200
• 401
• 422
• 500

---

Detalhes do plano retornados com sucesso

application/json

Schema

Example (from schema)

---

Schema

id string

O ID do plano.

uuid string

O UUID do plano.

name string

O nome do plano.

public_name string

O nome público do plano.

methods array

Os métodos de pagamento do plano.

value number

O valor do plano.

fine number

A multa do plano.

interest number

O juros do plano.

interval number

O intervalo do plano.

interval_type string

O tipo de intervalo do plano.

charges number

As cobranças do plano.

trial_days number

Os dias de teste do plano.

retry_days number

Os dias de tentativa do plano.

automatic_cancel boolean

O cancelamento automático do plano.

url string

A URL do plano.

custom_layout_enabled boolean

A habilitação do layout personalizado do plano.

custom_layout string

O layout personalizado do plano.

redirect_uri string

A URI de redirecionamento do plano.

status string

O status do plano.

custom_fields array

Os campos personalizados do plano.

billing_products array

Os produtos de cobrança do plano.

company object

A empresa do plano.

charge_enabled boolean

A habilitação da cobrança do plano.

billing_settings object

As configurações de cobrança do plano.

dunning object

O dunning do plano.

created_at date-time

A data e hora em que o plano foi criado.

updated_at date-time

A data e hora em que o plano foi atualizado.

{
  "id": "string",
  "uuid": "string",
  "name": "string",
  "public_name": "string",
  "methods": [
    null
  ],
  "value": 0,
  "fine": 0,
  "interest": 0,
  "interval": 0,
  "interval_type": "string",
  "charges": 0,
  "trial_days": 0,
  "retry_days": 0,
  "automatic_cancel": true,
  "url": "string",
  "custom_layout_enabled": true,
  "custom_layout": "string",
  "redirect_uri": "string",
  "status": "string",
  "custom_fields": [
    null
  ],
  "billing_products": [
    null
  ],
  "company": {},
  "charge_enabled": true,
  "billing_settings": {},
  "dunning": {},
  "created_at": "2024-10-02T18:42:13.256Z",
  "updated_at": "2024-10-02T18:42:13.256Z"
}

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