Skip to main content
POST
Adicionar uma nova assinatura

Authorizations

apiKey
string
header
required

API key no formato keyId.secret.

Body

application/json
companyId
string
required

ID da empresa da assinatura.

Minimum string length: 1
productId
string
required

ID do produto usado na assinatura v2.

Minimum string length: 1
clientId
string
required

ID de um cliente ja cadastrado na Veepag.

Minimum string length: 1
dueDate
required

Data de vencimento usada para criar a primeira cobranca.

referenceId
string

Referencia externa da sua aplicacao para a assinatura.

metadata
object

Metadados livres para conciliacao e suporte.

paymentMethod
enum<string>

Metodos de pagamento disponiveis para a assinatura.

Available options:
CREDIT_CARD,
DEBIT_CARD,
BOLETO,
PIX
origin
enum<string>
default:API

Origem da criacao da assinatura, quando informada.

Available options:
API,
CHECKOUT,
IMPORTED,
AFFILIATE
affiliateId
string

ID do afiliado vinculado, quando houver.

Response

Assinatura e cobranca criadas.

Resposta da criacao v2. Retorna assinatura e cobranca criadas, sem tentativa de pagamento imediato.

subscription
object

Assinatura criada pelo endpoint v2.

charge
object

Cobranca criada junto com a assinatura v2.