HomeGuiaAPI ReferenceNovidadesComunidade
API Reference

Criar assinatura

post
https://sandbox.api.assinaturas.pagseguro.com/subscriptions
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Utilize esse recurso para criar uma nova assinatura vinculando um assinante a um plano. Você pode criar o assinante no momento da criação da assinatura, mas isso não é obrigatório. Se o assinante foi criado previamente, você pode fornecer apenas o id, no formato CUST_XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX, recebido no momento da sua criação.

📘

Pagamento com cartão de crédito

Caso o seu cliente selecione a opção de pagamento com cartão de crédito, no momento de criação da assinatura você irá informar apenas o código de segurança (security_code) do cartão. Isso, porque o cartão foi previamente tokenizado.

Caso você esteja criando o seu assinante no momento de criação da assinatura, os dados complementares do cartão serão fornecidos no objeto customer.billing_info.

📘

Acesse o guia do serviço de Pagamentos Recorrentes para mais informações sobre seu funcionamento e funcionalidades disponíveis.

Você também pode consultar o guia específico da funcionalidade de assinaturas.

📘

Split de pagamento

Você pode configurar a divisão de pagamentos em transações recorrentes. Para saber mais sobre como utilizar essa funcionalidade, acesse a página Pagamento recorrente com divisão de recebíveis.

Body Params
string

Identificador da assinatura na sua aplicação (MAX 65 caracteres). ⚠️Obrigatório⚠️

plan
object

Objeto contendo informações do plano que será usado na assinatura. ⚠️Obrigatório⚠️

customer
object

Se você está criando a assinatura para um assinante já cadastrado, você precisa fornecer apenas o respectivo id do assinante, desconsiderando os demais parâmetros.
Se você deseja cadastrar um novo assinante com a criação da assinatura, forneça todos os parâmetros marcados como ⚠️Obrigatório⚠️. Para esse cenário, você não deve informar o parâmetro id.

coupon
object

Objeto contendo informações do cupom de desconto, quando aplicável.

payment_method
array of objects

Objeto contendo as informações de pagamento que o assinante optou para aderir a essa assinatura. ⚠️Obrigatório⚠️

payment_method
amount
object

Objeto contendo as informações do valor a ser cobrado. Se não informado, será utilizado o valor definido no momento da criação do plano vinculado à assinatura para criar a cobrança.

boolean

Campo para especificar se assinatura deve ser criada com pró-rata ou não.
Valores: True ou False

best_invoice_date
object

Objeto com melhor data para próxima cobrança

boolean

Define se o recurso de divisão de pagamento (split) será ativado para assinaturas. Quando definido como true, o split será aplicado conforme a configuração do objeto split.
⚠️ Caso não deseje utilizar o recurso não é envie esse parâmetro false.

splits
object

Objeto que define as regras de divisão (percentual ou valor fixo) de uma transação recorrente (assinatura) entre até 15 recebedores.
⚠️ Obrigatório quando split_enabled for true.
🚫 Não deve ser enviado quando split_enabled for false ou não estiver presente.

Headers
string
required

Token de autenticação. Deve ser enviado no formato Bearer <token>.

string

Chave composta de caracteres alfanumérico, exceto caracteres especiais. As chaves são recicladas depois de um intervalo não específico. Com isso, é garantido sua eficiência por 48 horas (Max 200 caracteres).

Responses

Updated about 1 year ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago

© 1996- Todos os direitos reservados.

PAGSEGURO INTERNET INSTITUIÇÃO DE PAGAMENTO S/A - CNPJ/MF 08.561.701/0001-01

Av. Brigadeiro Faria Lima, 1.384, São Paulo - SP - CEP 01451-001