PApagar

Obter plano

Changed on

A partir do identificador de um plano criado (plan_id) é possível recuperar as informações deste plano.

get/plans/{plan_id}

Request

  • Base URL
    https://api.pagar.me/core/v5
  • URL
    https://api.pagar.me/core/v5/plans/{plan_id}
  • Auth
    HTTP basic

Path parameters

plan_idstring required

Código do plano.<br>Formato: plan_XXXXXXXXXXXXXXXX.

Response

200

idstring
namestring
urlstring
currencystring
intervalstring
interval_countinteger
billing_typestring
installmentsinteger
statusstring
minimum_priceinteger
created_atstring
updated_atstring

Example response

{
  "id": "plan_21r4CTG0ux77Qv13",
  "name": "Plano Gold",
  "url": "/plan_21r4CTG0ux77Qv13/academia/plano-gold",
  "currency": "BRL",
  "interval": "month",
  "interval_count": 3,
  "billing_type": "prepaid",
  "installments": 3,
  "status": "active",
  "minimum_price": 10000,
  "created_at": "2016-07-12T18:25:40Z",
  "updated_at": "2016-07-12T18:25:40Z",
  "items": [
    {
      "id": "pi_3j1EG9ousipHjcUL",
      "name": "Musculação",
      "status": "active",
      "created_at": "2016-07-12T18:25:40Z",
      "updated_at": "2016-07-12T18:25:40Z",
      "pricing_scheme": {
        "price": 18990,
        "scheme_type": "unit"
      }
    }
  ],
  "metadata": {
    "id": "my_plan_id"
  }
}

Changes