Pagar.me v5 · Docs Legacy
Editar preço mínimo da assinatura
Com o verbo HTTP PATCH, através do identificador da assinatura (subscription_id) é possível atualizar o minimum price da assinatura.
patch
https://api.stone.com.br/core/v5/subscriptions/{subscription_id}/minimum_price
Path Parameters
subscription_idstringrequired
Código da assinatura.
Formato: sub_XXXXXXXXXXXXXXXX.
Body
application/json
Body
application/json
minimum_priceinteger(int32)
Valor mínimo da assinatura em centavos.
Response
application/json
Response
application/json
200
idstring
Example:sub_JrvX5MpS6Niq9wzL
codestring
Example:6NXQF71FJD
start_atstring
Example:2022-03-10T00:00:00Z
intervalstring
Example:month
interval_countinteger
Default:0
Example:1
billing_typestring
Example:prepaid
current_cycleobject
Show Child Parameters
next_billing_atstring
Example:2022-04-10T00:00:00Z
payment_methodstring
Example:boleto
currencystring
Example:BRL
installmentsinteger
Default:0
Example:1
minimum_priceinteger
Default:0
Example:100
statusstring
Example:active
boleto_due_daysinteger
Default:0
Example:20
created_atstring
Example:2022-03-10T19:42:17Z
updated_atstring
Example:2022-03-10T19:42:56Z
customerobject
Show Child Parameters
itemsarray[object]
Show Child Parameters
patch/subscriptions/{subscription_id}/minimum_price
Authentication
Path Parameters
Body
{
"minimum_price": "100"
}
application/json
Ativar faturamento manual
Configuração da assinatura que indica se o faturamento será feito de forma manual ou automática.Caso esteja ativa, as faturas não serão geradas automaticamente pelo nosso sistema, ficando a cargo do lojista realizar o faturamento pelo endpoint Criar Fatura.
post
https://api.stone.com.br/core/v5/subscriptions/{subscription_id}/manual-billing
Path Parameters
subscription_idstringrequired
Código da assinatura.
Formato: sub_XXXXXXXXXXXXXXXX.
Response
application/json
Response
application/json
200
idstring
Example:sub_kpWeWOBcOcpqe8jg
codestring
Example:PX7ECLF6Y3
start_atstring
Example:2019-05-07T00:00:00Z
intervalstring
Example:month
interval_countinteger
Default:0
Example:1
billing_typestring
Example:postpaid
next_billing_atstring
Example:2019-06-07T00:00:00Z
payment_methodstring
Example:credit_card
currencystring
Example:BRL
installmentsinteger
Default:0
Example:1
statusstring
Example:active
created_atstring
Example:2019-05-07T21:32:28Z
updated_atstring
Example:2019-05-07T21:33:22Z
manual_billingboolean
Default:true
Example:true
post/subscriptions/{subscription_id}/manual-billing
Authentication
Path Parameters
application/json
Desativar faturamento manual
Configuração da assinatura que indica se o faturamento será feito de forma manual ou automática.
Caso esteja desativada, as faturas serão geradas automaticamente pelo nosso sistema.
delete
https://api.stone.com.br/core/v5/subscriptions/{subscription_id}/manual-billing
Path Parameters
subscription_idstringrequired
Código da assinatura.
Formato: sub_XXXXXXXXXXXXXXXX.
Response
application/json
Response
application/json
200
idstring
Example:sub_kpWeWOBcOcpqe8jg
codestring
Example:PX7ECLF6Y3
start_atstring
Example:2019-05-07T00:00:00Z
intervalstring
Example:month
interval_countinteger
Default:0
Example:1
billing_typestring
Example:postpaid
next_billing_atstring
Example:2019-06-07T00:00:00Z
payment_methodstring
Example:credit_card
currencystring
Example:BRL
installmentsinteger
Default:0
Example:1
statusstring
Example:active
created_atstring
Example:2019-05-07T21:32:28Z
updated_atstring
Example:2019-05-07T21:32:38Z
delete/subscriptions/{subscription_id}/manual-billing
Authentication
Path Parameters
application/json
Teste - Criar assinatura avulsa
Fornecemos a possibilidade de criação de uma assinatura (subscription) sem a necessidade de criação de um plano (plan).
post
https://api.stone.com.br/core/v5/subscriptions2
Body
application/json
Body
application/json
payment_methodstringrequired
Meio de pagamento.
Valores possíveis: credit_card, boleto e debit_card .
Default:credit_card
cardarray[object]
Cartão
- 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.
Show Child Parameters
boleto_due_daysinteger(int32)
Dias para expiração do boleto. (Caso não seja passado, será pego um valor padrão das configurações da loja)
codestring
Código da assinatura no sistema da loja. Máx.: 52 caracteres
currencystring
Moeda. Valores possíveis: BRL
Default:BRL
start_atstring
Data de início da assinatura.
Se não for informada, a assinatura será iniciada imediatamente.
intervalstring
Intervalo da recorrência.
Valores possíveis: day, week, month ou year.
Default:month
interval_countinteger(int32)
Número de intervalos de acordo com a propriedade interval entre cada cobrança da assinatura.
Ex.: plano mensal = interval_count (1) e interval (month)
plano trimestral = interval_count (3) e interval (month)
plano semestral = interval_count (6) e** interval** (month)
Default:1
minimum_priceinteger(int32)
Valor mínimo em centavos da assinatura.
Default:null
billing_typestring
Tipo de cobrança.
Valores possíveis: prepaid, **postpaid **ou exact_day.
Default:prepaid
billing_dayinteger(int32)
Dia da cobrança.
Obrigatório, caso o billing_type seja exact_day
installmentsinteger(int32)
Quantidade de parcelas.
Será aplicada caso o método de pagamento da assinatura seja cartão de crédito.
Default:1
statement_descriptorstring
Texto exibido na fatura do cartão.
Será aplicado caso o método de pagamento da assinatura seja cartão de crédito. Máx.: 13 caracteres
customer_idstringrequired
Código do cliente.
Obrigatório caso o customer não seja informado. Saiba mais sobre clientes
customerobjectrequired
Dados do cliente.
Obrigatório caso o customer_id não seja informado. Saiba mais sobre clientes
Show Child Parameters
itemsarray[object]required
Itens do assinatura.
Saiba mais sobre item da assinatura
Show Child Parameters
setuparray[object]
Pedido que pode ser criado assim que a assinatura for iniciada. Ex: Pode ser utilizado como uma taxa de adesão ao serviço.
Show Child Parameters
discountsarray[object]
Descontos.
Show Child Parameters
incrementsarray[object]
Incrementos
Show Child Parameters
gateway_affiliation_idstring
Código da afiliação no gateway.
metadataobject
Objeto chave/valor utilizado para armazenar informações adicionais sobre a assinatura.
Saiba mais sobre metadata.
Response
application/json
Response
application/json
200
idstring
Example:sub_8RQW76TG8SOeYZro
codestring
Example:3R0ZSQ5BJ5
start_atstring
Example:2018-04-04T00:00:00Z
intervalstring
Example:month
interval_countinteger
Default:0
Example:1
billing_typestring
Example:prepaid
current_cycleobject
Show Child Parameters
next_billing_atstring
Example:2018-05-04T00:00:00Z
payment_methodstring
Example:boleto
currencystring
Example:BRL
installmentsinteger
Default:0
Example:1
statusstring
Example:active
created_atstring
Example:2018-04-04T20:59:01Z
updated_atstring
Example:2018-04-04T20:59:01Z
customerobject
Show Child Parameters
itemsarray[object]
Show Child Parameters
post/subscriptions2
Authentication
Body
{
"code": "123456",
"payment_method": "credit_card",
"currency": "BRL",
"start_at": "2025-04-03",
"interval": "month",
"interval_count": "1",
"minimum_price": "10000",
"billing_type": "exact_day",
"billing_day": 10,
"installments": 5,
"statement_descriptor": "Assinatura x",
"customer": {
"name": "Tony Stark",
"email": "tonystark@avengers.com",
"type": "individual",
"document": "28619068040"
},
"card": {
"holder_name": "Tony Stark",
"number": "4000000000000010",
"exp_month": 1,
"exp_year": 30,
"cvv": "903",
"billing_address": {
"line_1": "375, Av. General Justo, Centro",
"line_2": "8º andar",
"zip_code": "20021130",
"city": "Rio de Janeiro",
"state": "RJ",
"country": "BR"
}
},
"items": [
{
"description": "Musculação",
"quantity": 1,
"pricing_scheme": {
"price": 18990
}
}
],
"setup": {
"amount": "2000",
"description": "Taxa de adesão",
"payment": {
"payment_method": "credit_card",
"credit_card": {
"card": {
"holder_name": "Tony Stark",
"number": "4000000000000010",
"exp_month": 1,
"exp_year": 30,
"cvv": "903",
"billing_address": {
"line_1": "375, Av. General Justo, Centro",
"line_2": "8º andar",
"zip_code": "20021130",
"city": "Rio de Janeiro",
"state": "RJ",
"country": "BR"
}
}
}
}
},
"metadata": {
"id": "my_subscription_id"
}
}
application/json
Incluir item
Através do identificador da assinatura (subscription_id) é possível incluir itens na assinatura do cliente.
post
https://api.stone.com.br/core/v5/subscriptions/{subscription_id}/items
Path Parameters
subscription_idstringrequired
Código da assinatura.
Formato: sub_XXXXXXXXXXXXXXXX.
Body
application/json
Body
application/json
plan_item_idstring
Código do item do plano.
Max: 36 caracteres.
descriptionstringrequired
Descrição do item.
Max: 256 caracteres.
Obrigatório caso o plan_item_id não seja informado.
cyclesinteger(int32)
Indica quantas vezes o item será cobrado.
Caso não seja informado, o item será cobrado até que seja excluído o desativado.
pricing_schemeobjectrequired
Esquema de precificação.
Saiba mais sobre precificação.
Show Child Parameters
discountsarray[object]
Descontos do item.
Saiba mais sobre desconto
Show Child Parameters
quantityinteger(int32)required
Quantidade de itens.
Obrigatório caso pricing_scheme.scheme_type seja unit
namestring
Nome do item da assinatura.
incrementsarray[object]
Incrementos do item.
Saiba mais sobre desconto
Show Child Parameters
Response
application/json
Response
application/json
200
idstring
Example:si_WQEmvEEfGigkL0Zx
descriptionstring
Example:Celular
cyclesinteger
Default:0
Example:1
quantityinteger
Default:0
Example:1
statusstring
Example:active
created_atstring
Example:2017-07-28T21:00:26Z
updated_atstring
Example:2017-07-28T21:00:26Z
pricing_schemeobject
Show Child Parameters
subscriptionobject
Show Child Parameters
post/subscriptions/{subscription_id}/items
Authentication
Path Parameters
Body
{
"description": "Celular",
"cycles": 1,
"quantity": 1,
"pricing_scheme": {
"price": 99
}
}
application/json