Dom Docs
Dom Pagamentos

Criar assinatura

POSThttps://{apiUrl}/recurrence/subscriptions

Atualizado em · 2 min de leitura

Na Dom Pagamentos, é possível criar uma assinatura sem vínculo com um plano, para isso, basta configurar o objeto auto_recurring.

Já uma assinatura vinculada a um plano, é necessário enviar o identificador único do plano, nó plan_id.

🚧 Caso envie um plano e também uma configuração de recorrência, usaremos as configurações que estão presentes na assinatura, em auto_recurring.

Endpoint: POST https://{apiUrl}/recurrence/subscriptions

Parâmetros

POSThttps://{apiUrl}/recurrence/subscriptions
URL base da API
Token de autenticação
Body Params
payment_methodstringrequired

Método de pagamento: "credit_card", "boleto" ou "pix"

customer_idstringoptional

ID do cliente existente

customerobjectoptional

Dados do cliente (se não usar customer_id)

plan_idstringoptional

ID do plano a vincular

auto_recurringobjectoptional

Configuração de recorrência independente (sobrescreve o plano)

curl --request POST \
  --url "https://{apiUrl}/recurrence/subscriptions" \
  --header "Content-Type: application/json" 
  --data '{}'
Response

Choose an example:

application/json

Caso envie um plan_id e também um objeto auto_recurring, as configurações de auto_recurring terão prioridade sobre as do plano.

Exemplo de resposta

json
{
  "id": "assinatura-uuid-aqui",
  "plan_id": null,
  "customer_id": "cliente-uuid-aqui",
  "status": "active",
  "payment_method": "credit_card",
  "created_at": "2024-03-09 22:37:55",
  "next_billing_date": "2024-04-09"
}
Campos da resposta
idstring

UUID único da assinatura criada

plan_idstring

UUID do plano vinculado, ou null se sem plano

customer_idstring

UUID do cliente vinculado à assinatura

statusstring

Estado: active, cancelled, suspended

payment_methodstring

Método de cobrança: credit_card, boleto ou pix

created_atstring

Data de criação da assinatura

next_billing_datestring

Data da próxima cobrança no formato YYYY-MM-DD

Esta página foi útil?