Pagar.me v5 · Docs Legacy
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
Listar itens de uma assinatura
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/{subscription_id}/items
Path Parameters
subscription_idstringrequired
Body
application/json
Body
application/json
statusstring
Status da assinatura.
Valores possíveis: active, *deleted
namestring
Nome do item da assinatura.
descriptionstring
Descrição do item.
cycleinteger(int32)
Indica quantas vezes o item será cobrado.
Caso não seja informado, o item será cobrado até que seja excluído o desativado.
created_sincestring(date)
Data de início do item de criação a ser listado.
created_untilstring(date-time)
Data final do item 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/{subscription_id}/items
Authentication
Path Parameters
Body
{}
application/json
Editar item
Com o verbo HTTP PUT, através dos identificadores do item (subscription_item_id) e da assinatura (subscription_id) associada é possível atualizar os dados do item da assinatura.
put
https://api.stone.com.br/core/v5/subscriptions/{subscription_id}/items/{item_id}
Path Parameters
subscription_idstringrequired
Código da assinatura.
Formato: sub_XXXXXXXXXXXXXXXX.
item_idstringrequired
Código do item da assinatura.
Formato: si_XXXXXXXXXXXXXXXX.
Body
application/json
Body
application/json
namestring
Nome do item da assinatura.
descriptionstring
Descrição do item.
Max: 256 caracteres.
Obrigatório caso o plan_item_id não seja informado.
cycleinteger(int32)
Indica quantas vezes o item será cobrado.
Caso não seja informado, o item será cobrado até que seja excluído o desativado.
pageinteger(int32)
Página atual
Default:1
sizeinteger(int32)
Quantidade de itens por página.
Default:10
quantityinteger(int32)required
Quantidade de itens.
Obrigatório caso pricing_scheme.scheme_type seja unit.
pricing_schemeobject
Esquema de precificação.
Saiba mais sobre precificação
Show Child Parameters
Response
application/json
Response
application/json
200
idstring
Example:si_mARl1OvTYcA3pG49
descriptionstring
Example:Telefone
cyclesinteger
Default:0
Example:3
quantityinteger
Default:0
Example:1
statusstring
Example:active
created_atstring
Example:2017-04-04T18:56:44Z
updated_atstring
Example:2017-04-04T18:57:48Z
pricing_schemeobject
Show Child Parameters
subscriptionobject
Show Child Parameters
put/subscriptions/{subscription_id}/items/{item_id}
Authentication
Path Parameters
Body
{
"name": "Nome - teste",
"description": "Telefone",
"cycles": 3,
"quantity": 1,
"pricing_scheme": {
"price": 99
}
}
application/json
Remover item
Com o verbo HTTP DELETE, através dos identificadores do item (subscription_item_id) e da assinatura (subscription_id) associada é possível remover um item da assinatura.
delete
https://api.stone.com.br/core/v5/subscriptions/{subscription_id}/items/{item_id}
Path Parameters
subscription_idstringrequired
Código da assinatura.
Formato: sub_XXXXXXXXXXXXXXXX.
item_idstringrequired
Código do item da assinatura.
Formato: si_XXXXXXXXXXXXXXXX.
Response
application/json
Response
application/json
200
idstring
Example:si_mARl1OvTYcA3pG49
descriptionstring
Example:Telefone
cyclesinteger
Default:0
Example:3
quantityinteger
Default:0
Example:1
namestring
Example:Nome - teste
statusstring
Example:deleted
created_atstring
Example:2017-04-04T18:56:44Z
updated_atstring
Example:2017-04-04T18:57:48Z
deleted_atstring
Example:2017-04-04T19:00:44Z
pricing_schemeobject
Show Child Parameters
subscriptionobject
Show Child Parameters
delete/subscriptions/{subscription_id}/items/{item_id}
Authentication
Path Parameters
application/json
Incluir uso
Este recurso permite incluir um usage de um items associado a uma subscription.
post
https://api.stone.com.br/core/v5/subscriptions/{subscription_id}/items/{item_id}/usages
Path Parameters
subscription_idstringrequired
Código da assinatura.
Formato: sub_XXXXXXXXXXXXXXXX.
item_idstringrequired
Código do item da assinatura.
Formato: si_XXXXXXXXXXXXXXXX.
Body
application/json
Body
application/json
quantityinteger(int32)
Quantidade de usos a serem incluídos.
Default:1
descriptionstring
Descrição do uso.
codestring
Código de identificação no sistema do cliente
groupstring
Código de identificação do grupo no sistema do cliente
Response
application/json
Response
application/json
200
idstring
Example:usage_QV1gBLhalU35RNbx
quantityinteger
Default:0
Example:1
statusstring
Example:active
used_atstring
Example:2017-04-04T18:21:50Z
created_atstring
Example:2017-04-04T18:21:50Z
subscription_itemobject
Show Child Parameters
post/subscriptions/{subscription_id}/items/{item_id}/usages
Authentication
Path Parameters
Body
{
"quantity": 50
}
application/json