Pagar.me v5 · Docs Legacy
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
Listar uso
Este recurso permite listar os usos de um item de assinatura.
get
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
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
dataarray[object]
Show Child Parameters
pagingobject
Show Child Parameters
get/subscriptions/{subscription_id}/items/{item_id}/usages
Authentication
Path Parameters
Body
{}
application/json
Remover uso
Com o verbo HTTP DELETE, através dos identificadores do uso (usage_id), do item (subscription_item_id) a da assinatura associada (subscription_id), é possível excluir o uso do item de uma assinatura.
delete
https://api.stone.com.br/core/v5/subscriptions/{subscription_id}/items/{item_id}/usages/{usage_id}
Path Parameters
subscription_idstringrequired
Código da assinatura.
Formato: sub_XXXXXXXXXXXXXXXX.
item_idstringrequired
Código do item da assinatura.
Formato: si_XXXXXXXXXXXXXXXX.
usage_idstringrequired
Código do uso.
Formato: usage_XXXXXXXXXXXXXXXX.
Response
application/json
Response
application/json
200
idstring
Example:usage_QV1gBLhalU35RNbx
quantityinteger
Default:0
Example:1
statusstring
Example:deleted
used_atstring
Example:2017-04-04T18:21:50Z
created_atstring
Example:2017-04-04T18:21:50Z
deleted_atstring
Example:2017-04-04T18:24:57Z
subscription_itemobject
Show Child Parameters
delete/subscriptions/{subscription_id}/items/{item_id}/usages/{usage_id}
Authentication
Path Parameters
application/json
Incluir item
Através do identificador do plano (plan_id) é possível incluir itens ao plano associado.
post
https://api.stone.com.br/core/v5/plans/{plan_id}/items
Path Parameters
plan_idstringrequired
Código do plano.
Formato: plan_XXXXXXXXXXXXXXXX
Body
application/json
Body
application/json
namestringrequired
Nome do item.
Max.: 64 caracteres.
descriptionstring
Descrição do item.
Max.: 256 caracteres.
quantityinteger(int32)
Quantidade de itens.
Obrigatório, caso o pricing_scheme.type for igual a unit.
cyclesinteger(int32)
Número de ciclos durante o qual o item será cobrado. Ex: Um item com cycles = 1 representa que um item será cobrado apenas uma vez.
Caso não seja informado, o item será cobrado até que seja desativado.
pricing_schemeobjectrequired
Esquema de precificação.
Saiba mais sobre precificação.
Show Child Parameters
Response
application/json
Response
application/json
200
idstring
Example:pi_eBTaVnXD8Zhb8glr
namestring
Example:Avaliação física
cyclesinteger
Default:0
Example:1
statusstring
Example:active
created_atstring
Example:2016-07-12T18:25:40Z
updated_atstring
Example:2016-07-12T18:25:40Z
pricing_schemeobject
Show Child Parameters
planobject
Show Child Parameters
post/plans/{plan_id}/items
Authentication
Path Parameters
Body
{
"name": "Avaliação física",
"cycles": 1,
"quantity": 1,
"pricing_scheme": {
"price": 9990,
"scheme_type": "unit"
}
}
application/json
Editar item
Com o verbo HTTP PUT, através dos identificadores do item (plan_item_id) e do plano (plan_id) associado é possível atualizar os dados do item do plano.
put
https://api.stone.com.br/core/v5/plans/{plan_id}/items/{item_id}
Path Parameters
plan_idstringrequired
Código do plano.
Formato: plan_XXXXXXXXXXXXXXXX
item_idstringrequired
Código do item do plano.
Formato: pi_XXXXXXXXXXXXXXXX
Body
application/json
Body
application/json
namestringrequired
Nome do item.
Max.: 64 caracteres.
descriptionstring
Descrição do item.
Max.: 256 caracteres.
quantityinteger(int32)
Quantidade de itens.
Obrigatório, caso o pricing_scheme.type for igual a unit.
cyclesinteger(int32)
Número de ciclos durante o qual o item será cobrado. Ex: Um item com cycles = 1 representa que um item será cobrado apenas uma vez.
Caso não seja informado, o item será cobrado até que seja desativado.
pricing_schemeobjectrequired
Esquema de precificação.
Saiba mais sobre precificação.
Show Child Parameters
statusstringrequired
Valores possíveis: active ou inactive
Response
application/json
Response
application/json
200
idstring
Example:pi_eBTaVnXD8Zhb8glr
namestring
Example:Avaliação física
descriptionstring
Example:Avaliação + Exame médico
cyclesinteger
Default:0
Example:1
statusstring
Example:active
created_atstring
Example:2016-07-12T18:25:40Z
updated_atstring
Example:2016-07-12T18:25:40Z
pricing_schemeobject
Show Child Parameters
planobject
Show Child Parameters
put/plans/{plan_id}/items/{item_id}
Authentication
Path Parameters
Body
{
"name": "Avaliação física",
"description": "Avaliação + Exame médico",
"quantity": 1,
"cycles": 1,
"pricing_scheme": {
"price": 9990,
"scheme_type": "unit"
}
}
application/json