v1

latestOpenAPI 3.1.02026-07-241040774.6 KB

Editar metadados do plano

Com o verbo HTTP PATCH, através do identificador do plano (plan_id) é possível atualizar o objeto metadata do plano.

patch/plans/plan_id/metadata

Path parameters

plan_idstring required

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

Request body

metadataobject required

Objeto chave/valor utilizado para armazenar informações adicionais sobre o plano. Saiba mais sobre metadata

Response

200

idstring

namestring

descriptionstring

urlstring

statement_descriptorstring

intervalstring

interval_countinteger

minimum_priceinteger

billing_typestring

payment_methodsstring[]

installmentsinteger[]

statusstring

currencystring

created_atstring

updated_atstring

Example response

{
  "id": "plan_jEJWD1qF2Xf92eKv",
  "name": "Premium",
  "description": "Vá de Premium. E seja feliz!",
  "url": "/plans/plan_jEJWD1qF2Xf92eKv/mundipagg-teste/premium",
  "statement_descriptor": "Spotify",
  "interval": "month",
  "interval_count": 1,
  "minimum_price": 10000,
  "billing_type": "postpaid",
  "payment_methods": [
    "boleto"
  ],
  "installments": [
    1
  ],
  "status": "active",
  "currency": "BRL",
  "created_at": "2017-08-10T21:27:08Z",
  "updated_at": "2017-08-10T21:33:24Z",
  "items": [
    {
      "id": "pi_JDG10BpS1sKwboXk",
      "name": "Premium",
      "quantity": 1,
      "status": "active",
      "created_at": "2017-08-10T21:27:08Z",
      "updated_at": "2017-08-10T21:27:08Z",
      "pricing_scheme": {
        "price": 1490,
        "scheme_type": "unit"
      }
    }
  ],
  "metadata": {
    "code": "1234",
    "company": "Avengers"
  }
}