Pagar.me v5 · Docs Legacy
Criar plano
Este recurso possibilita a criação de um plan que poderá ser utilizado futuramente para a criação de uma assinatura. Para mais detalhes consulte a pagina principal do objeto.
post
https://api.stone.com.br/core/v5/plans
Body
application/json
Body
application/json
namestringrequired
Nome do plano. Max: 64 caracteres.
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. O número de parcelas deverá ser 1 em recorrências.
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. Max: 13 caracteres.
currencystring
Moeda. Valores possíveis: BRL.
intervalstring
Frequência 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
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[object]
Itens do plano. Saiba mais sobre um itens do plano
Show Child Parameters
metadatastring
Objeto chave/valor utilizado para armazenar informações adicionais sobre o plano.
Saiba mais sobre metadata
pricing_schemeobject
Esquema de precificação.
Obrigatório na ausência de items.
Show Child Parameters
quantityinteger(int32)
Quantidade para o pricing_scheme.
Obrigatório quando o pricing_scheme.scheme_type for igual a unit.
Default:null
Response
application/json
Response
application/json
200
post/plans
Authentication
Body
{
"name": "Plano Gold",
"currency": "BRL",
"interval": "month",
"interval_count": 3,
"billing_type": "prepaid",
"minimum_price": 10000,
"installments": [
3
],
"payment_methods": [
"credit_card",
"boleto"
],
"items": [
{
"name": "Musculação",
"quantity": 1,
"pricing_scheme": {
"price": 18990
}
},
{
"name": "Matrícula",
"cycles": 1,
"quantity": 1,
"pricing_scheme": {
"price": 5990
}
}
],
"metadata": {
"id": "my_plan_id"
}
}
application/json
Listar planos
Este recurso permite listar seus planos. Pode ser utilizados alguns parâmetros como filtro da listagem.
get
https://api.stone.com.br/core/v5/plans
Query Parameters
namestring
Nome do plano.
statusstring
Status do plano.
Valores possíveis: active, inactive ou deleted
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.
sizeinteger(int32)
Quantidade de itens por página.
Response
application/json
Response
application/json
200
dataarray[object]
Show Child Parameters
pagingobject
Show Child Parameters
get/plans
Authentication
Query Parameters
application/json
Obter plano
A partir do identificador de um plano criado (plan_id) é possível recuperar as informações deste plano.
get
https://api.stone.com.br/core/v5/plans/{plan_id}
Path Parameters
plan_idstringrequired
Código do plano.
Formato: plan_XXXXXXXXXXXXXXXX.
Response
application/json
Response
application/json
200
idstring
Example:plan_21r4CTG0ux77Qv13
namestring
Example:Plano Gold
urlstring
Example:/plan_21r4CTG0ux77Qv13/academia/plano-gold
currencystring
Example:BRL
intervalstring
Example:month
interval_countinteger
Default:0
Example:3
billing_typestring
Example:prepaid
installmentsinteger
Default:0
Example:3
statusstring
Example:active
minimum_priceinteger
Default:0
Example:10000
created_atstring
Example:2016-07-12T18:25:40Z
updated_atstring
Example:2016-07-12T18:25:40Z
itemsarray[object]
Show Child Parameters
metadataobject
Show Child Parameters
get/plans/{plan_id}
Authentication
Path Parameters
application/json
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