Sign in

v1

latestOpenAPI 3.1.02026-07-24750514.9 KB

Criar assinatura

post/subscriptions

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 da assinatura na sua aplicação (MAX 65 caracteres). ⚠️Obrigatório⚠️

pro_rataboolean

Campo para especificar se assinatura deve ser criada com pró-rata ou não. <br><small>Valores: True ou False</small>

split_enabledboolean

Define se o recurso de divisão de pagamento (split) será ativado para assinaturas. Quando definido como true, o split será aplicado conforme a configuração do objeto split. <br/> ⚠️ Caso não deseje utilizar o recurso não é envie esse parâmetro false.

Response

200

idstring
reference_idstring
statusstring
next_invoice_atstring
pro_rataboolean
created_atstring
updated_atstring
exp_atstring

Example response

{
  "id": "SUBS_ABBCAE87-7435-4DB5-B371-CDE4A8B7C885",
  "reference_id": "subscription-review-qa-a",
  "amount": {
    "value": 1000,
    "currency": "BRL"
  },
  "status": "OVERDUE",
  "plan": {
    "id": "PLAN_94FEECCB-EECD-4A79-A093-C4381CF4CA16",
    "name": "automation_test_1641842839057"
  },
  "payment_method": [
    {
      "type": "CREDIT_CARD",
      "card": {
        "token": "TOKE_EC5084B1-EE9F-46BE-9605-BBFCC52677E0",
        "brand": "visa",
        "first_digits": "438935",
        "last_digits": "7511",
        "exp_month": "06",
        "exp_year": "2027",
        "holder": {
          "name": "João da Silva"
        }
      }
    }
  ],
  "next_invoice_at": "2022-10-01",
  "customer": {
    "id": "CUST_06466370-B37F-40D1-9831-55ADE75BFA8A",
    "name": "Elo 57cents",
    "email": "cent123s@email.com.br"
  },
  "created_at": "2022-09-01T14:44:22.937-03:00",
  "updated_at": "2022-09-01T14:44:24.869-03:00",
  "exp_at": "2023-07-01",
  "links": [
    {
      "rel": "SELF",
      "href": "http://qa.api.assinaturas.pagseguro.com/subscriptions",
      "media": "application/json",
      "type": "GET"
    }
  ]
}