Criar assinatura
https://{apiUrl}/recurrence/subscriptionsAtualizado 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
https://{apiUrl}/recurrence/subscriptionsMétodo de pagamento: "credit_card", "boleto" ou "pix"
ID do cliente existente
Dados do cliente (se não usar customer_id)
ID do plano a vincular
Configuração de recorrência independente (sobrescreve o plano)
curl --request POST \
--url "https://{apiUrl}/recurrence/subscriptions" \
--header "Content-Type: application/json"
--data '{}'Choose an example:
Caso envie um
plan_ide também um objetoauto_recurring, as configurações deauto_recurringterão prioridade sobre as do plano.
Exemplo de resposta
{
"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"
}UUID único da assinatura criada
UUID do plano vinculado, ou null se sem plano
UUID do cliente vinculado à assinatura
Estado: active, cancelled, suspended
Método de cobrança: credit_card, boleto ou pix
Data de criação da assinatura
Data da próxima cobrança no formato YYYY-MM-DD