Criar assinatura

post

https://{apiUrl}/recurrence/subscriptions

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.

Body Params

customer_id

string

required

ID do cliente

plan_id

string

ID do plano de assinatura.

auto_recurring

object

Configuração de recorrência para assinaturas avulsas, ou seja, que não são vinculadas a um plano, ou que, devem sobrepor as configurações do plano.

payment_method

string

enum

required

Defaults to credit_card

Meio de pagamento da assinatura

Allowed:

card

object

Informações da cobrança por cartão de crédito

cashback_active

boolean

Defaults to false

Se definido como true, o cliente receberá bônus de cashback e o lojista terá o desconto do custo do serviço.

postbackurl

string

URL para receber webhook dos status das faturas de cada ciclo da cobrança.

metadata

string

Objeto chave/valor utilizado para armazenar informações adicionais sobre a assinatura.

start_date_invoice

date

Forçar uma data para o processamento da primeira fatura. Se não definido, o sistema seguirá conforme o esquema da recorrência em: frequency, frequency_type, billing_day e billing_type

external_reference

string

Código de referência da loja

platform

object

Para uso de plataformas de e-commerce

Responses

🚧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.

200200

400400

🚧
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.