Pagar.me v5 · Docs Legacy

Pagar.me v5 API (Legado)

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
metadatastring

Objeto chave/valor utilizado para armazenar informações adicionais sobre a fatura. Saiba mais sobre metadata

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

Body

{}
 
application/json

Obter fatura

Através do identificador da fatura (invoice_id) é possível recuperar as informação da fatura.

get
https://api.stone.com.br/core/v5/invoices/{invoice_id}

Path Parameters

invoice_idstringrequired

Código da fatura.
Formato: in_XXXXXXXXXXXXXXXX.

Response

application/json

200

idstring

Example:in_qBY5VvpuEACaw5bg

codestring

Example:O5D5FRSQ9O

urlstring

Example:/invoices/in_qBY5VvpuEACaw5bg

amountinteger

Default:0

Example:1490

total_discountsinteger

Default:0

Example:1000

total_incrementsinteger

Default:0

Example:1000

statusstring

Example:paid

payment_methodstring

Example:credit_card

due_atstring

Example:2017-04-19T00:00:00Z

created_atstring

Example:2017-04-19T17:35:15Z

itemsarray[object]
Show Child Parameters
customerobject
Show Child Parameters
subscriptionobject
Show Child Parameters
cycleobject
Show Child Parameters
chargeobject
Show Child Parameters
get/invoices/{invoice_id}
 
application/json

Cancelar fatura

Com o verbo HTTP DELETE, através do identificador da fatura (invoice_id), este recurso possibilita realizar o cancelamento da fatura.

delete
https://api.stone.com.br/core/v5/invoices/{invoice_id}

Path Parameters

invoice_idstringrequired

Código da fatura.
Formato: in_XXXXXXXXXXXXXXXX.

Response

application/json

200

idstring

Example:in_n87qwY1FA2SzwXDb

codestring

Example:P47FWGIEZP

urlstring

Example:/invoices/in_n87qwY1FA2SzwXDb

amountinteger

Default:0

Example:1490

statusstring

Example:canceled

payment_methodstring

Example:credit_card

due_atstring

Example:2017-04-04T00:00:00Z

canceled_atstring

Example:2017-04-04T15:48:48Z

created_atstring

Example:2017-04-04T15:40:28Z

itemsarray[object]
Show Child Parameters
customerobject
Show Child Parameters
subscriptionobject
Show Child Parameters
cycleobject
Show Child Parameters
chargeobject
Show Child Parameters
delete/invoices/{invoice_id}
 
application/json

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

200

dataarray[object]
Show Child Parameters
pagingobject
Show Child Parameters
get/invoices
 
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
metadatastringrequired

Objeto chave/valor utilizado para armazenar informações adicionais sobre a fatura.
Saiba mais sobre metadata

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

Body

{ "metadata": { "code": "1234", "company": "Avengers" } }
 
application/json