Pagar.me v5 · Docs Legacy
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
Obter incremento
Através dos identificadores da assinatura (subscription_id) e do incremento associado (incremento_id) é possível recuperar as informações do incremento.
get
https://api.stone.com.br/core/v5/subscriptions/{subscription_id}/increments/{increment_id}
Path Parameters
subscription_idstringrequired
Código da assinatura.
Formato sub_XXXXXXXXXXXXXXXX
increment_idstringrequired
Código do incremento.
Formato: dis_XXXXXXXXXXXXXXXX
Response
application/json
Response
application/json
200
idstring
Example:inc_IYzpxgjsOs0fDIoP
valueinteger
Default:0
Example:10
increment_typestring
Example:percentage
statusstring
Example:active
created_atstring
Example:2017-04-04T18:36:43Z
subscriptionobject
Show Child Parameters
get/subscriptions/{subscription_id}/increments/{increment_id}
Authentication
Path Parameters
application/json
Remover incremento
Com o verbo HTTP DELETE, através dos identificadores do incremento (increment_id) e da assinatura associada (subscription_id) é possível remover um incremento do plano.
delete
https://api.stone.com.br/core/v5/subscriptions/{subscription_id}/increments/{increment_id}
Path Parameters
subscription_idstringrequired
Código da assinatura.
Formato sub_XXXXXXXXXXXXXXXX
increment_idstringrequired
Código do incremento.
Formato: dis_XXXXXXXXXXXXXXXX.
Response
application/json
Response
application/json
200
idstring
Example:inc_IYzpxgjsOs0fDIoP
valueinteger
Default:0
Example:20
increment_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}/increments/{increment_id}
Authentication
Path Parameters
application/json
Criar fatura
Este recurso cria uma fatura (invoice) de acordo com o identificador do ciclo a ser cobrado (cycle_id) de um determinada assinatura (subscription_id).
post
https://api.stone.com.br/core/v5/subscriptions/{subscription_id}/cycles/{cycle_id}/pay
Path Parameters
subscription_idstringrequired
Código da assinatura.
Formato: sub_XXXXXXXXXXXXXXXX.
cycle_idstringrequired
Código do ciclo.
Formato: cycle_XXXXXXXXXXXXXXXX.
Body
application/json
Body
application/json
metadatastring
Objeto chave/valor utilizado para armazenar informações adicionais sobre a fatura. Saiba mais sobre metadata
Response
application/json
Response
application/json
200
idstring
Example:in_6d2BVXnaUdT8DOkL
codestring
Example:59QDSPB5NP
urlstring
Example:/invoices/in_6d2BVXnaUdT8DOkL
amountinteger
Default:0
Example:1490
statusstring
Example:paid
payment_methodstring
Example:credit_card
due_atstring
Example:2017-04-04T00:00:00Z
created_atstring
Example:2017-04-04T15:10:35Z
itemsarray[object]
Show Child Parameters
customerobject
Show Child Parameters
subscriptionobject
Show Child Parameters
cycleobject
Show Child Parameters
chargeobject
Show Child Parameters
post/subscriptions/{subscription_id}/cycles/{cycle_id}/pay
Authentication
Path Parameters
Body
{}
application/json