Skip to main content
POST
/
v1
/
subscription
Adicionar uma nova assinatura
curl --request POST \
  --url https://sandbox.api.veepag.com/v1/subscription \
  --header 'Content-Type: application/json' \
  --header 'apiKey: <api-key>' \
  --data '
{
  "companyId": "company_id",
  "product": {
    "id": "product_id"
  },
  "paymentMethod": "CREDIT_CARD",
  "installments": 1,
  "client": {
    "name": "Cliente Teste",
    "doc": "12345678909",
    "email": "cliente@example.com"
  },
  "paymentProfile": {
    "holderName": "CLIENTE TESTE",
    "cardNumber": "4111111111111111",
    "cardExpiration": "10/2026",
    "cardCvv": "123"
  },
  "metadata": {
    "externalOrderId": "pedido_123"
  }
}
'
{
  "id": "subscription_id",
  "transactionId": [
    "transaction_id"
  ],
  "status": "ACTIVE",
  "paymentMethod": "CREDIT_CARD",
  "charge": {
    "statusCode": 200,
    "amount": {
      "value": 9900,
      "currency": "BRL"
    },
    "status": "PAID",
    "message": "Pagamento aprovado",
    "acquirer": {},
    "qrCode": null,
    "boleto": null
  }
}

Authorizations

apiKey
string
header
required

API key no formato keyId.secret.

Body

application/json
companyId
string
required
Minimum string length: 1
product
object
required
paymentMethod
enum<string>
required
Available options:
CREDIT_CARD,
DEBIT_CARD,
BOLETO,
PIX
installments
integer
default:1
required
referenceId
string | null
origin
enum<string>
default:API
Available options:
API,
CHECKOUT,
IMPORTED,
AFFILIATE
captchaToken
string
metadata
object
paymentProfile
object
cardAuthId
string | null
client
object
affiliateId
string | null
url
string

Response

Assinatura criada e pagamento tentado.

id
string
Example:

"subscription_id"

transactionId
string[]
Example:
["transaction_id"]
status
enum<string>
Available options:
ACTIVE,
ERROR_PAYMENT,
NO_PAYMENT_ROUTE,
CREATED,
PENDING_PAYMENT,
RECOVERED,
NO_PAYMENT,
CANCELED_ALERT_ETHOCA,
BLOCKED,
CANCELED_MANUAL,
IMPORTED,
STANDBY,
OVERDUE
nextCharge
string<date-time>
paymentMethod
enum<string>
Available options:
CREDIT_CARD,
DEBIT_CARD,
BOLETO,
PIX
charge
object