v1

latestOpenAPI 3.1.02026-07-241040774.6 KB

Excluir plano

Com o verbo HTTP DELETE, através do identificador do plano (plan_id) é possível excluir um plano.

delete/plans/{plan_id}

Query parameters

plan_idstring required

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

Response

200

idstring

namestring

descriptionstring

urlstring

minimum_priceinteger

currencystring

intervalstring

interval_countinteger

billing_typestring

installmentsinteger

statement_descriptorstring

statusstring

created_atstring

updated_atstring

deleted_atstring

Example response

{
  "id": "plan_21r4CTG0ux77Qv13",
  "name": "Plano Gold",
  "description": "Esse plano oferece acesso aos programas de musculação e todos os equipamentos e atividades coletivas terrestres.",
  "url": "/plan_21r4CTG0ux77Qv13/academia/plano-silver",
  "minimum_price": 10000,
  "currency": "BRL",
  "interval": "month",
  "interval_count": 3,
  "billing_type": "prepaid",
  "installments": 3,
  "statement_descriptor": "SILVER",
  "status": "deleted",
  "created_at": "2016-07-12T18:25:40Z",
  "updated_at": "2016-07-12T18:25:40Z",
  "deleted_at": "2016-07-15T13:41:02Z",
  "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"
  }
}