Pagar.me v5 · Docs Legacy
Remover item
Com o verbo HTTP DELETE, através dos identificadores do item (plan_item_id) e do plano (plan_id) associado é possível remover um item do plano.
delete
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
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: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
pricing_schemeobject
Show Child Parameters
planobject
Show Child Parameters
delete/plans/{plan_id}/items/{item_id}
Authentication
Path Parameters
application/json
Incluir desconto
Este recurso permite adicionar um desconto, através do identificador da assinatura (subscription_id).
post
https://api.stone.com.br/core/v5/subscriptions/{subscription_id}/discounts
Path Parameters
subscription_idstringrequired
Código da assinatura.
Formato sub_XXXXXXXXXXXXXXXX
Body
application/json
Body
application/json
valuestringrequired
Valor do desconto.
discount_typestringrequired
Tipo do desconto.
Valores possíveis: flat ou percentage. O padrão é percentage
cyclesstring
Indica quantas vezes o desconto será aplicado.
Caso não seja informado, o desconto será aplicado até que o item seja excluído
item_idstring
Código do item da assinatura.
Formato: si_XXXXXXXXXXXXXXXX
Caso seja informado, o desconto será aplicado no item. Max: 36 caracteres
Response
application/json
Response
application/json
200
idstring
Example:dis_LP4j5dXztPSj5A02
valueinteger
Default:0
Example:10
discount_typestring
Example:percentage
cyclesinteger
Default:0
Example:1
statusstring
Example:active
created_atstring
Example:2019-05-22T14:23:55Z
updated_atstring
Example:2019-05-22T14:23:55Z
subscriptionobject
Show Child Parameters
post/subscriptions/{subscription_id}/discounts
Authentication
Path Parameters
Body
{
"value": 10,
"discount_type": "percentage",
"cycles": "1",
"item_id": "si_GyL1lmGU6tOXYr2O"
}
application/json
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