Pagar.me v5 · Docs Legacy

Pagar.me v5 API (Legado)

Listar assinaturas

Este recurso permite listar as assinaturas. Pode ser utilizados alguns parâmetros como filtro da listagem.

get
https://api.stone.com.br/core/v5/subscriptions

Query Parameters

statusstring

Status da assinatura.
Valores possíveis: active, canceled ou future

codestring

Código da assinatura no sistema da loja. Máx.: 52 caracteres

billing_typestring

Tipo de cobrança.
Valores possíveis: prepaid, **postpaid **ou exact_day.

customer_idstring

Código do cliente. Saiba mais sobre clientes.

plan_idstring

Código do plano.
Formato: plan_XXXXXXXXXXXXXXXX.

card_idstring

Código do cartão.
Formato: card_XXXXXXXXXXXXXXXX.

next_billing_sincestring(date)

Data de início da próxima data de cobrança.

next_billing_untilstring(date)

Data final de próxima data de cobrança.

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/subscriptions
 
application/json

Obter assinatura com split

Este recurso possibilita, através do identificador da assinatura (subscription_id), recuperar as informações da assinatura com Split.

get
https://api.stone.com.br/core/v5/subscriptions/{subscription_id}

Path Parameters

subscription_idstringrequired

Código da Assinatura.
Formato: sub_XXXXXXXXXXXXXXXX.

Response

application/json

200

object
get/subscriptions/{subscription_id}
 
application/json

Cancelar assinatura

Com o verbo HTTP DELETE, através do identificador da assinatura (subscription_id) é possível cancelar a assinatura.

delete
https://api.stone.com.br/core/v5/subscriptions/{subscription_id}

Path Parameters

subscription_idstringrequired

Código da assinatura.
Formato: sub_XXXXXXXXXXXXXXXX.

Body

application/json
cancel_pending_invoicesboolean

Parâmetro que define se as cobranças e faturas pendentes dentro de uma assinatura serão canceladas automaticamente com a execução do cancelamento da assinatura

Default:true

Response

application/json

200

idstring

Example:sub_WeEMlp2FXFMjVq3Q

codestring

Example:8YNU49TD4Z

start_atstring

Example:2018-04-05T00:00:00Z

intervalstring

Example:month

interval_countinteger

Default:0

Example:1

billing_typestring

Example:postpaid

boleto_due_daysinteger

Default:0

Example:5

current_cycleobject
Show Child Parameters
setupobject
Show Child Parameters
next_billing_atstring

Example:2018-04-05T00:00:00Z

payment_methodstring

Example:boleto

currencystring

Example:BRL

statement_descriptorstring

Example:Spotify

installmentsinteger

Default:0

Example:1

statusstring

Example:canceled

created_atstring

Example:2018-04-05T03:20:16Z

updated_atstring

Example:2018-04-05T12:14:06Z

canceled_atstring

Example:2018-04-05T12:14:06Z

customerobject
Show Child Parameters
planobject
Show Child Parameters
itemsarray[object]
Show Child Parameters
delete/subscriptions/{subscription_id}

Body

{}
 
application/json

Editar cartão da assinatura

Com o verbo HTTP PATCH, através do identificador da assinatura (subscription_id) é possível atualizar o cartão utilizado para pagamento da assinatura.

patch
https://api.stone.com.br/core/v5/subscriptions/{subscription_id}/card

Path Parameters

subscription_idstringrequired

Código da assinatura.
Formato: sub_XXXXXXXXXXXXXXXX.

Body

application/json
card_idstring

Código do cartão.
Formato: card_XXXXXXXXXXXXXXXX.

cardstring

Dados do novo cartão.Saiba mais sobre cartões

Response

application/json

200

idstring

Example:sub_WeEMlp2FXFMjVq3Q

codestring

Example:8YNU49TD4Z

start_atstring

Example:2018-04-05T00:00:00Z

intervalstring

Example:month

interval_countinteger

Default:0

Example:1

billing_typestring

Example:postpaid

boleto_due_daysinteger

Default:0

Example:5

current_cycleobject
Show Child Parameters
setupobject
Show Child Parameters
next_billing_atstring

Example:2018-05-05T00:00:00Z

payment_methodstring

Example:credit_card

currencystring

Example:BRL

statement_descriptorstring

Example:Spotify

installmentsinteger

Default:0

Example:1

statusstring

Example:active

created_atstring

Example:2018-04-05T03:20:16Z

updated_atstring

Example:2018-04-05T03:20:16Z

customerobject
Show Child Parameters
cardobject
Show Child Parameters
planobject
Show Child Parameters
itemsarray[object]
Show Child Parameters
patch/subscriptions/{subscription_id}/card

Body

{ "card": { "number": "4532912167490007", "holder_name": "Tony Stark", "exp_month": 6, "exp_year": 30, "cvv": "474", "billing_address": { "line_1": "375, Av. General Justo, Centro", "line_2": "8º andar", "zip_code": "20021130", "city": "Rio de Janeiro", "state": "RJ", "country": "BR" } } }
 
application/json

Editar data de faturamento da assinatura

Com o verbo HTTP PATCH, através do identificador da assinatura (subscription_id) é possível atualizar a data de faturamento da assinatura.

patch
https://api.stone.com.br/core/v5/subscriptions/{subscription_id}/billing-date

Path Parameters

subscription_idstringrequired

Código da assinatura.
Formato: sub_XXXXXXXXXXXXXXXX.

Body

application/json
next_billing_atstringrequired

Próxima data de cobrança.

Response

application/json

200

idstring

Example:sub_lmxK4k0hPfJ5z58w

codestring

Example:9X8HROC4E0

start_atstring

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

intervalstring

Example:month

interval_countinteger

Default:0

Example:1

billing_typestring

Example:prepaid

gateway_affiliation_idstring

Example:C56A4180-65AA-42EC-A945-5FD21DEC0538

boleto_due_daysinteger

Default:0

Example:5

minimum_priceinteger

Default:0

Example:10000

current_cycleobject
Show Child Parameters
next_billing_atstring

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

payment_methodstring

Example:credit_card

currencystring

Example:BRL

statement_descriptorstring

Example:Spotify

installmentsinteger

Default:0

Example:1

statusstring

Example:active

created_atstring

Example:2017-04-03T19:04:24Z

updated_atstring

Example:2017-04-03T19:04:24Z

customerobject
Show Child Parameters
credit_cardobject
Show Child Parameters
planobject
Show Child Parameters
itemsarray[object]
Show Child Parameters
patch/subscriptions/{subscription_id}/billing-date

Body

{ "next_billing_at": "2020-04-03" }
 
application/json