Criar assinatura

Criar assinatura

post

Cria uma nova assinatura

Autorizações

ApiKeyAuth

Parâmetros de cabeçalho

X-Token-ApistringObrigatório

Token de autenticação para acesso à API

Content-Typestring · enumOpcional

Tipo de conteúdo da requisição

Valores possíveis:

x-ip-origin-requeststringOpcional

IP de origem da requisição

x-idempotency-keystringOpcional

Chave de idempotência para evitar duplicidade

Corpo

application/json

uuidPlanstring · uuidObrigatório

uuidBuyerstring · uuidObrigatório

startDatestring · dateObrigatório

Respostas

201

Assinatura criada com sucesso

application/json

400

Erro de validação ou negócio

application/json

401

Token inativo ou inexistente

application/json

403

Acesso negado

application/json

415

Tipo de mídia não suportado

application/json

500

Erro interno do servidor

application/json

post

HTTPcURLJavaScriptPython

POST /v2/subscriptions HTTP/1.1
Host: api.barte.com
X-Token-Api: text
Content-Type: application/json
Accept: */*
Content-Length: 567

{
  "uuidPlan": "123e4567-e89b-12d3-a456-426614174000",
  "basicValue": {
    "type": "MONTHLY",
    "valuePerMonth": 1
  },
  "additionalValue": {
    "installments": 1,
    "value": 1
  },
  "payment": {
    "method": "CREDIT_CARD",
    "card": {
      "holderName": "JOAO DA SILVA",
      "number": "4111111111111111",
      "expiration": "12/2025",
      "cvv": "123",
      "buyerUuid": "550e8400-e29b-41d4-a716-446655440000"
    },
    "fraudData": {
      "document": "12345678900",
      "email": "[e-mail]",
      "name": "João da Silva",
      "phone": "11999999999"
    }
  },
  "uuidBuyer": "123e4567-e89b-12d3-a456-426614174000",
  "startDate": "2025-09-26",
  "metadata": [
    {
      "key": "text",
      "value": "text"
    }
  ]
}

{
  "uuid": "text",
  "status": "PENDING",
  "customer": {
    "uuid": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "email": "[e-mail]",
    "document": "text"
  },
  "startDate": "2025-09-26",
  "value": {
    "type": "MONTHLY",
    "valuePerMonth": 1
  },
  "additionalValue": {
    "installments": 1,
    "value": 1
  },
  "paymentMethod": "CREDIT_CARD",
  "charges": [
    {
      "uuid": "123e4567-e89b-12d3-a456-426614174000",
      "status": "ABANDONED",
      "value": 1,
      "createdAt": "2025-09-26T16:55:15.970Z",
      "updatedAt": "2025-09-26T16:55:15.970Z"
    }
  ]
}