Pagar.me v5 · Docs Legacy
Editar plano
Com o verbo HTTP PUT, através do identificador do plano (plan_id) é possível atualizar os dados do plano.
put
https://api.stone.com.br/core/v5/plans/{plan_id}
Path Parameters
plan_idstringrequired
Código do plano.
Formato: plan_XXXXXXXXXXXXXXXX.
Body
application/json
Body
application/json
namestringrequired
Nome do plano. Max: 64 caracteres.
statusstringrequired
Status do plano. Valores possíveis: active ou inactive
descriptionstring
Descrição do plano.
shippableboolean
Indica se o plano oferece entrega.
payment_methodsarray[string]
Meios de pagamento disponíveis para assinaturas criadas a partir do plano.
Valores possíveis: credit_card, boleto ou debit_card. Caso nenhum seja informado, o único meio de pagamento disponível por padrão será credit_card
installmentsarray[integer](int32)
Opções de parcelamento disponíveis para assinaturas criadas a partir do plano.
Caso não seja informado, o plano irá disponibilizar apenas assinaturas com pagamentos à vista.
minimum_priceinteger(int32)
Valor mínimo em centavos da fatura.
statement_descriptorstring
Texto exibido na fatura do cartão.
Será aplicado para assinaturas de cartão de crédito criadas a partir do plano.
currencystringrequired
Moeda. Valores possíveis: BRL, ARS, BOB, CLP, **COP **, MXN, PYG, **USD **, UYU e EUR.
intervalstringrequired
Frequência da recorrência. Valores possíveis: day,week, month ou year.
Default:month
interval_countinteger(int32)required
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
trial_period_daysinteger(int32)
Dias de teste. A assinatura será iniciada após o término deste período.
billing_typestring
Tipo de cobrança. Valores possíveis: prepaid, **postpaid **ou exact_day.
billing_daysarray[integer](int32)
Dias disponíveis para cobrança das assinaturas criadas a partir do plano. Deve ser maior ou igual a 1 e menor ou igual a 28. Obrigatório, caso o billing_type seja igual a exact_day.
itemsarray
Itens do plano. Saiba mais sobre um itens do plano
metadatastring
Objeto chave/valor utilizado para armazenar informações adicionais sobre o plano.
Saiba mais sobre metadata
Response
application/json
Response
application/json
200
idstring
Example:plan_21r4CTG0ux77Qv13
namestring
Example:Plano Gold
descriptionstring
Example:Esse plano oferece acesso aos programas de musculação e todos os equipamentos e atividades coletivas terrestres.
urlstring
Example:/plan_21r4CTG0ux77Qv13/academia/plano-silver
currencystring
Example:BRL
intervalstring
Example:month
interval_countinteger
Default:0
Example:3
billing_typestring
Example:prepaid
installmentsinteger
Default:0
Example:3
statement_descriptorstring
Example:SILVER
statusstring
Example:active
created_atstring
Example:2016-07-12T18:25:40Z
updated_atstring
Example:2016-07-12T18:25:40Z
minimum_priceinteger
Default:0
Example:10000
itemsarray[object]
Show Child Parameters
metadataobject
Show Child Parameters
put/plans/{plan_id}
Authentication
Path Parameters
Body
{
"name": "Plano Silver",
"description": "Esse plano oferece acesso aos programas de musculação e todos os equipamentos e atividades coletivas terrestres.",
"currency": "BRL",
"interval": "month",
"interval_count": 3,
"billing_type": "prepaid",
"statement_descriptor": "SILVER",
"minimum_price": 10000,
"status": "active",
"payment_methods": [
"credit_card"
]
}
application/json
Excluir plano
Com o verbo HTTP DELETE, através do identificador do plano (plan_id) é possível excluir um plano.
delete
https://api.stone.com.br/core/v5/plans/{plan_id}
Path Parameters
plan_idstringrequired
Código do plano
Response
application/json
Response
application/json
200
idstring
Example:plan_21r4CTG0ux77Qv13
namestring
Example:Plano Gold
descriptionstring
Example:Esse plano oferece acesso aos programas de musculação e todos os equipamentos e atividades coletivas terrestres.
urlstring
Example:/plan_21r4CTG0ux77Qv13/academia/plano-silver
minimum_priceinteger
Default:0
Example:10000
currencystring
Example:BRL
intervalstring
Example:month
interval_countinteger
Default:0
Example:3
billing_typestring
Example:prepaid
installmentsinteger
Default:0
Example:3
statement_descriptorstring
Example:SILVER
statusstring
Example:deleted
created_atstring
Example:2016-07-12T18:25:40Z
updated_atstring
Example:2016-07-12T18:25:40Z
deleted_atstring
Example:2016-07-15T13:41:02Z
itemsarray[object]
Show Child Parameters
metadataobject
Show Child Parameters
delete/plans/{plan_id}
Authentication
Path Parameters
application/json
Editar metadados do plano
Com o verbo HTTP PATCH, através do identificador do plano (plan_id) é possível atualizar o objeto metadata do plano.
patch
https://api.stone.com.br/core/v5/plans/{plan_id}/metadata
Path Parameters
plan_idstringrequired
Código do plano.
Formato: plan_XXXXXXXXXXXXXXXX.
Body
application/json
Body
application/json
metadataobjectrequired
Objeto chave/valor utilizado para armazenar informações adicionais sobre o plano.
Response
application/json
Response
application/json
200
idstring
Example:plan_jEJWD1qF2Xf92eKv
namestring
Example:Premium
descriptionstring
Example:Vá de Premium. E seja feliz!
urlstring
Example:/plans/plan_jEJWD1qF2Xf92eKv/pagarme-teste/premium
statement_descriptorstring
Example:Spotify
intervalstring
Example:month
interval_countinteger
Default:0
Example:1
minimum_priceinteger
Default:0
Example:10000
billing_typestring
Example:postpaid
payment_methodsarray[string]
Example:boleto
installmentsarray[integer]
Default:0
Example:1
statusstring
Example:active
currencystring
Example:BRL
created_atstring
Example:2017-08-10T21:27:08Z
updated_atstring
Example:2017-08-10T21:33:24Z
itemsarray[object]
Show Child Parameters
metadataobject
Show Child Parameters
patch/plans/{plan_id}/metadata
Authentication
Path Parameters
Body
{
"metadata": {
"code": "1234",
"company": "Avengers"
}
}
application/json
Criar assinatura de plano
Fornecemos a possibilidade de criação de uma assinatura (subscription) a partir de plano (plan).
post
https://api.stone.com.br/core/v5/subscriptions
Body
application/json
Body
application/json
codestring
Código da assinatura no sistema da loja. Máx.: 52 caracteres
plan_idstringrequired
Código do plano.
Formato: plan_XXXXXXXXXXXXXXXX
payment_methodstringrequired
Meio de pagamento.
Valores possíveis: credit_card, boleto e debit_card .
start_atstring(date)
Data de início da assinatura.
Se não for informada, a assinatura será iniciada imediatamente.
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
cardobjectrequired
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.
Show Child Parameters
installmentsinteger(int32)
Quantidade de parcelas.
O número de parcelas deverá ser 1 em recorrências.
Default:1
discountsarray[object]
Descontos.
Show Child Parameters
incrementsarray[object]
Incrementos
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)
metadatastring
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_bpYjMr9f8sA6QJNg
codestring
Example:XPLMBV9U10
start_atstring
Example:2018-04-04T00:00:00Z
intervalstring
Example:month
interval_countinteger
Default:0
Example:1
billing_typestring
Example:postpaid
current_cycleobject
Show Child Parameters
next_billing_atstring
Example:2018-05-04T00:00:00Z
payment_methodstring
Example:boleto
currencystring
Example:BRL
statement_descriptorstring
Example:Spotify
installmentsinteger
Default:0
Example:1
statusstring
Example:active
created_atstring
Example:2018-04-04T21:36:13Z
updated_atstring
Example:2018-04-04T21:36:13Z
customerobject
Show Child Parameters
planobject
Show Child Parameters
itemsarray[object]
Show Child Parameters
post/subscriptions
Authentication
Body
{
"plan_id": "plan_21r4CTG0ux77Qv13",
"payment_method": "credit_card",
"boleto_due_days": 5,
"customer": {
"name": "Tony Stark",
"email": "tonystark@avengers.com"
},
"card": {
"holder_name": "Tony Stark",
"number": "4532464862385322",
"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"
}
},
"discounts": [
{
"cycles": 3,
"value": 10,
"discount_type": "percentage"
}
],
"increments": [
{
"cycles": 2,
"value": 20,
"discount_type": "percentage"
}
],
"metadata": {
"id": "my_subscription_id"
}
}
application/json
Listar assinaturas
Este recurso permite listar as assinaturas. Pode ser utilizados alguns parâmetros como filtro da listagem.
get
https://api.stone.com.br/core/v5/subscriptions
Query Parameters
statusstring
Status da assinatura.
Valores possíveis: active, canceled ou future
codestring
Código da assinatura no sistema da loja. Máx.: 52 caracteres
billing_typestring
Tipo de cobrança.
Valores possíveis: prepaid, **postpaid **ou exact_day.
customer_idstring
Código do cliente. Saiba mais sobre clientes.
plan_idstring
Código do plano.
Formato: plan_XXXXXXXXXXXXXXXX.
card_idstring
Código do cartão.
Formato: card_XXXXXXXXXXXXXXXX.
next_billing_sincestring(date)
Data de início da próxima data de cobrança.
next_billing_untilstring(date)
Data final de próxima data de cobrança.
created_sincestring(date)
Data de início do período de criação a ser listado.
created_untilstring(date)
Data final do período de criação a ser listado.
pageinteger(int32)
Página atual
Default:1
sizeinteger(int32)
Quantidade de itens por página.
Default:10
Response
application/json
Response
application/json
200
dataarray[object]
Show Child Parameters
pagingobject
Show Child Parameters
get/subscriptions
Authentication
Query Parameters
application/json