Pagar.me v5 · Docs Legacy
Listar descontos
Este recurso permite listar os descontos associados a uma assinatura.
get
https://api.stone.com.br/core/v5/subscriptions/{subscription_id}/discounts
Path Parameters
subscription_idstringrequired
Código da assinatura.
Formato sub_XXXXXXXXXXXXXXXX
Response
application/json
Response
application/json
200
dataarray[object]
Show Child Parameters
pagingobject
Show Child Parameters
get/subscriptions/{subscription_id}/discounts
Authentication
Path Parameters
application/json
Obter desconto
Através dos identificadores da assinatura (subscription_id) e do desconto associado (discount_id) é possível recuperar as informações do desconto.
get
https://api.stone.com.br/core/v5/subscriptions/{subscription_id}/discounts/{discount_id}
Path Parameters
subscription_idstringrequired
Código da assinatura.
Formato sub_XXXXXXXXXXXXXXXX
discount_idstringrequired
Código do desconto.
Formato: dis_XXXXXXXXXXXXXXXX
Response
application/json
Response
application/json
200
idstring
Example:dis_brMgW6KCdmf2dEQ7
valueinteger
Default:0
Example:10
discount_typestring
Example:percentage
statusstring
Example:active
created_atstring
Example:2017-04-04T18:36:43Z
subscriptionobject
Show Child Parameters
get/subscriptions/{subscription_id}/discounts/{discount_id}
Authentication
Path Parameters
application/json
Remover desconto
Com o verbo HTTP DELETE, através dos identificadores do desconto (discount_id) e da assinatura associada (subscription_id) é possível remover um desconto do plano.
delete
https://api.stone.com.br/core/v5/subscriptions/{subscription_id}/discounts/{discount_id}
Path Parameters
subscription_idstringrequired
Código da assinatura.
Formato sub_XXXXXXXXXXXXXXXX
discount_idstringrequired
Código do desconto.
Formato: dis_XXXXXXXXXXXXXXXX
Response
application/json
Response
application/json
200
idstring
Example:dis_kqGj1JMCaGSRm9Yz
valueinteger
Default:0
Example:10
discount_typestring
Example:percentage
statusstring
Example:deleted
created_atstring
Example:2017-04-04T18:40:15Z
deleted_atstring
Example:2017-04-04T18:40:48Z
subscriptionobject
Show Child Parameters
delete/subscriptions/{subscription_id}/discounts/{discount_id}
Authentication
Path Parameters
application/json
Incluir incremento
Este recurso permite adicionar um incremento, através do identificador da assinatura (subscription_id).
post
https://api.stone.com.br/core/v5/subscriptions/{subscription_id}/increments
Path Parameters
subscription_idstringrequired
Código da assinatura.
Formato sub_XXXXXXXXXXXXXXXX
Body
application/json
Body
application/json
valuestringrequired
Valor do incremento.
increment_typestringrequired
Tipo do incremento.
Valores possíveis: flat ou percentage. O padrão é percentage
cyclesinteger(int32)
Indica quantas vezes o incremento será aplicado.
Caso não seja informada, o incremento será aplicado até que o item seja excluído
item_idstring
Código do item da assinatura.
Formato: si_XXXXXXXXXXXXXXXX
Caso seja informado, o incremento será aplicado no item. Max: 36 caracteres
Response
application/json
Response
application/json
200
idstring
Example:inc_IYzpxgjsOs0fDIoP
valueinteger
Default:0
Example:20
increment_typestring
Example:percentage
statusstring
Example:active
created_atstring
Example:2017-04-04T18:36:43Z
subscriptionobject
Show Child Parameters
post/subscriptions/{subscription_id}/increments
Authentication
Path Parameters
Body
{
"value": 20,
"increment_type": "percentage"
}
application/json
Listar incrementos
Este recurso permite listar os incrementos associados a uma assinatura.
get
https://api.stone.com.br/core/v5/subscriptions/{subscription_id}/increments
Path Parameters
subscription_idstringrequired
Código da assinatura.
Formato sub_XXXXXXXXXXXXXXXX
Response
application/json
Response
application/json
200
dataarray[object]
Show Child Parameters
pagingobject
Show Child Parameters
get/subscriptions/{subscription_id}/increments
Authentication
Path Parameters
application/json