Criar assinatura de plano

post

https://api.pagar.me/core/v5/subscriptions

Fornecemos a possibilidade de criação de uma assinatura (subscription) a partir de plano (plan).

Body Params

code

string

Código da assinatura no sistema da loja. Máx.: 52 caracteres

plan_id

string

required

Código do plano.
Formato: plan_XXXXXXXXXXXXXXXX

payment_method

string

required

Meio de pagamento.
Valores possíveis: credit_card, boleto e debit_card .

start_at

date

Data de início da assinatura.
Se não for informada, a assinatura será iniciada imediatamente.

customer_id

string

required

Código do cliente.
Obrigatório caso o customer não seja informado. Saiba mais sobre clientes.

customer

object

required

Dados do cliente.
Obrigatório caso o customer_id não seja informado. Saiba mais sobre clientes.

card

object

required

Cartão que será utilizado na assinatura.
- card_id é o código do cartão do cliente.
- card_token é token do cartão gerado pelo checkout transparente.
É obrigatório o envio de uma dessas identificações, caso o payment_method seja credit_card ou debit_card.
Saiba mais sobre cartões.

installments

int32

Defaults to 1

Quantidade de parcelas.
O número de parcelas deverá ser 1 em recorrências.

discounts

array of objects

Descontos.

discounts

increments

array of objects

Incrementos

increments

boleto_due_days

int32

Dias para expiração do boleto. (Caso não seja passado, será pego um valor padrão das configurações da loja)

metadata

string

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

Responses

Language

Credentials

Basic

base64

Request

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Transaction IDs

200200

400400