v1

latestOpenAPI 3.1.02026-07-24750514.9 KB

Alterar plano

put/plans/{plan_id}

Path parameters

plan_idstring required

Identificador único do plano que deseja alterar. Formato PLAN_XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX.

Headers

Authorizationstring required

Token de autenticação. Deve ser enviado no formato Bearer <token>.

x-idempotency-keystring

Chave composta de caracteres alfanumérico, exceto caracteres especiais. As chaves são recicladas depois de um intervalo não específico. Com isso, é garantido sua eficiência por 48 horas (Max 200 caracteres).

Request body

reference_idstring

Identificador único do plano na sua aplicação (Min 2; Max 65 caracteres). ⚠️Obrigatório⚠️

status'ACTIVE' | 'INACTIVE'

Define se o plano está ativo ou inativo.

namestring

Nome do plano na sua aplicação (Max 65 caracteres). ⚠️Obrigatório⚠️

descriptionstring

Descrição do plano na sua aplicação (Max 250 caracteres). ⚠️Obrigatório⚠️

setup_feeinteger

Taxa de contratação a ser cobrada na assinatura especificada em centavos de Real. Se não desejar cobrar uma taxa de contratação para o plano, o campo setup_fee deve ser deixado em branco ou não enviado como atributo (MAX 9 caracteres).

billing_cyclesinteger

Quantidade de ciclos (faturas) que a assinatura terá até expirar. Não informar este campo para que não haja expiração.

limit_subscriptioninteger

Quantidade máxima de assinaturas do plano. Para não haver limite, deixar esse campo em branco.

payment_methodstring[]

Formas de pagamentos aceitas no plano. Caso o atributo não seja informado, a forma de pagamento default é CREDIT_CARD. <br> <small>Exemplos: BOLETO, CREDIT_CARD</small>.

Response

200

idstring

reference_idstring

statusstring

namestring

descriptionstring

setup_feeinteger

limit_subscriptionsinteger

billing_cyclesinteger

payment_methodstring[]

created_atstring

updated_atstring

Example response

{
  "id": "PLAN_2EA005B2-7C4B-47D2-BED4-7AF2E850D2EA",
  "reference_id": "plano_teste",
  "status": "ACTIVE",
  "name": "Plano teste",
  "description": "Plano de 100 Reais",
  "amount": {
    "value": 10000,
    "currency": "BRL"
  },
  "setup_fee": 100,
  "limit_subscriptions": 100,
  "interval": {
    "length": 1,
    "unit": "MONTH"
  },
  "billing_cycles": 99,
  "trial": {
    "days": 10
  },
  "payment_method": [
    "CREDIT_CARD"
  ],
  "created_at": "2022-05-25T15:38:40.775-03:00",
  "updated_at": "2022-05-25T15:38:40.775-03:00",
  "links": [
    {
      "rel": "SELF",
      "href": "http://sandbox.api.assinaturas.pagseguro.com/plans/PLAN_2EA005B2-7C4B-47D2-BED4-7AF2E850D2EA",
      "media": "application/json",
      "type": "GET"
    }
  ]
}