Pagar.me v5 · Docs Legacy
Listar faturas
Este recurso permite listar os descontos associados a uma assinatura. Pode ser utilizados alguns parâmetros como filtro da listagem.
get
https://api.stone.com.br/core/v5/invoices
Query Parameters
statusstring
Status das faturas. Valores possíveis: pending, paid, canceled, scheduled ou failed
customer_idstring
Código do cliente.
subscription_idstring
Código da fatura.
due_sincestring(date)
Data de início do período de vencimento a ser listado.
due_untilstring(date)
Data final do período de vencimento a ser listado.
created_sincestring(date)
Data de início do período de criação a ser listado.
created_untilstring(date)
Data final do período 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/invoices
Authentication
Query Parameters
application/json
Editar metadados da fatura
Com o verbo HTTP PATCH, através do identificador da fatura (invoice_id) é possível atualizar o objeto metadata da fatura.
patch
https://api.stone.com.br/core/v5/invoices/{invoice_id}/metadata
Path Parameters
invoice_idstringrequired
Código da fatura.
Formato: in_XXXXXXXXXXXXXXXX.
Body
application/json
Body
application/json
metadatastringrequired
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_l9JGwX1MsNS3g614
codestring
Example:X8J8HG6HR3
urlstring
Example:/invoices/in_l9JGwX1MsNS3g614
amountinteger
Default:0
Example:1490
statusstring
Example:paid
payment_methodstring
Example:credit_card
due_atstring
Example:2017-08-10T00:00:00Z
created_atstring
Example:2017-08-10T16:02:40Z
itemsarray[object]
Show Child Parameters
customerobject
Show Child Parameters
subscriptionobject
Show Child Parameters
cycleobject
Show Child Parameters
chargeobject
Show Child Parameters
metadataobject
Show Child Parameters
patch/invoices/{invoice_id}/metadata
Authentication
Path Parameters
Body
{
"metadata": {
"code": "1234",
"company": "Avengers"
}
}
application/json
Renovar ciclo
Através do identificador da assinatura (subscription_id) é possível renovar o ciclo de uma assinatura. A utilização do método irá sempre renovar o ciclo à frente. Para Listar os ciclos de uma assinatura, acesse Listar Ciclos.
post
https://api.stone.com.br/core/v5/subscriptions/{subscription_id}/cycles
Path Parameters
subscription_idstringrequired
Código da assinatura.
Response
application/json
Response
application/json
200
idstring
Example:cycle_Qal5a0LCpphoDpnR
billing_atstring
Example:2019-04-30T00:00:00Z
cycleinteger
Default:0
Example:1
start_atstring
Example:2019-04-30T00:00:00Z
end_atstring
Example:2019-07-29T23:59:59Z
durationinteger
Default:0
Example:7862399
created_atstring
Example:2019-04-30T18:09:32Z
updated_atstring
Example:2019-04-30T18:12:20Z
statusstring
Example:billed
post/subscriptions/{subscription_id}/cycles
Authentication
Path Parameters
application/json
Listar ciclos
Este recurso permite listar os ciclos associados a uma assinatura. Podem ser utilizados alguns parâmetros como filtro da listagem.
get
https://api.stone.com.br/core/v5/subscriptions/{subscription_id}/cycles
Query Parameters
idstring
Código do ciclo. Formato: cycle_XXXXXXXXXXXXXXXX.
billing_atstring(date)
Data de cobrança do ciclo
cyclestring
Quantidade de ciclos na assinatura
start_atstring
Data de início do ciclo
end_atstring
Data final do ciclo
durationstring
created_atstring
Data de criação da assinatura
updated_atstring(date)
Data de atualização do ciclo da assinatura.
statusstring
Status dos ciclos. Valores possíveis: billed ou unbilled
Path Parameters
subscription_idstringrequired
Código da assinatura.
Response
application/json
Response
application/json
200
dataarray[object]
Show Child Parameters
pagingobject
Show Child Parameters
get/subscriptions/{subscription_id}/cycles
Authentication
Path Parameters
Query Parameters
application/json
Obter ciclo
Através do identificador do ciclo (cycle_id) é possível recuperar as informação do ciclo de uma assinatura.
get
https://api.stone.com.br/core/v5/subscriptions/{subscription_id}/cycles/{cycle_id}
Path Parameters
subscription_idstringrequired
Código da assinatura.
cycle_idstringrequired
Código do ciclo. Formato: cycle_XXXXXXXXXXXXXXXX.
Response
application/json
Response
application/json
200
idstring
Example:cycle_Qal5a0LCpphoDpnR
billing_atstring
Example:2019-04-30T00:00:00Z
cycleinteger
Default:0
Example:1
start_atstring
Example:2019-04-30T00:00:00Z
end_atstring
Example:2019-07-29T23:59:59Z
durationinteger
Default:0
Example:7862399
created_atstring
Example:2019-04-30T18:09:32Z
updated_atstring
Example:2019-04-30T18:09:33Z
statusstring
Example:billed
get/subscriptions/{subscription_id}/cycles/{cycle_id}
Authentication
Path Parameters
application/json