Pagar.me v5 · Docs Legacy
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
Body
application/json
next_billing_atstringrequired
Próxima data de cobrança.
Response
application/json
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
Authentication
Path Parameters
Body
{
"next_billing_at": "2020-04-03"
}
application/json
Editar metadados da assinatura
Com o verbo HTTP PATCH, através do identificador da assinatura (subscription_id) é possível atualizar o objeto metadata da assinatura.
patch
https://api.stone.com.br/core/v5/subscriptions/{subscription_id}/metadata
Path Parameters
subscription_idstringrequired
Código da assinatura.
Formato: sub_XXXXXXXXXXXXXXXX.
Body
application/json
Body
application/json
metadatastringrequired
Objeto chave/valor utilizado para armazenar informações adicionais sobre a assinatura.
Saiba mais sobre metadata
Response
application/json
Response
application/json
200
idstring
Example:sub_yOkq7oI03S7Wq741
codestring
Example:V9OMHENIK6
start_atstring
Example:2017-08-10T00:00:00Z
intervalstring
Example:month
interval_countinteger
Default:0
Example:1
billing_typestring
Example:postpaid
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
setupobject
Show Child Parameters
next_billing_atstring
Example:2017-09-10T00: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-08-10T21:27:13Z
updated_atstring
Example:2017-08-10T21:27:29Z
customerobject
Show Child Parameters
cardobject
Show Child Parameters
planobject
Show Child Parameters
itemsarray[object]
Show Child Parameters
metadataobject
Show Child Parameters
patch/subscriptions/{subscription_id}/metadata
Authentication
Path Parameters
Body
{
"metadata": {
"code": "1234",
"company": "Avengers"
}
}
application/json
Editar afiliação da assinatura no gateway
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}/gateway-affiliation-id
Path Parameters
subscription_idstringrequired
Código da assinatura.
Formato: sub_XXXXXXXXXXXXXXXX.
Body
application/json
Body
application/json
gateway_affiliation_idstringrequired
Código da afiliação no gateway.
Response
application/json
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}/gateway-affiliation-id
Authentication
Path Parameters
Body
{
"gateway_affiliation_id": "C56A4180-65AA-42EC-A945-5FD21DEC0538"
}
application/json
Editar meio de pagamento da assinatura
Com o verbo HTTP PATCH, através do identificador da assinatura (subscription_id) é possível atualizar o meio de pagamento da assinatura.
patch
https://api.stone.com.br/core/v5/subscriptions/{subscription_id}/payment-method
Path Parameters
subscription_idstringrequired
Código da assinatura.
Formato: sub_XXXXXXXXXXXXXXXX.
Body
application/json
Body
application/json
payment_methodstring
Meio de pagamento.
Valores possíveis: credit_card, boleto, cash ou debit_card . Deve-se adicionar o meio de pagamento após o objeto “payment_method”
cardobject
Dados do novo cartão.
Obrigatório , caso o payment_method escolhido seja credit_card e o card_id e o card_token não sejam informados.
card_idstring
Código do novo cartão.
Obrigatório , caso o payment_method escolhido seja credit_card e o objeto card e o card_token não sejam informados.
card_tokenstring
Token do novo cartão.
Obrigatório , caso o payment_method escolhido seja credit_card e o card_id e o card não sejam informados.
Saiba mais token de cartão
Response
application/json
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
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}/payment-method
Authentication
Path Parameters
Body
{
"payment_method": "boleto"
}
application/json
Editar data de início da assinatura
Com o verbo HTTP PATCH, através do identificador da assinatura (subscription_id) é possível atualizar a data de início da assinatura.
patch
https://api.stone.com.br/core/v5/subscriptions/{subscription_id}/start-at
Path Parameters
subscription_idstringrequired
Código da assinatura.
Formato: sub_XXXXXXXXXXXXXXXX.
Body
application/json
Body
application/json
start_atstring(date)required
Data de início da assinatura.
Response
application/json
Response
application/json
200
idstring
Example:sub_lmxK4k0hPfJ5z58w
codestring
Example:9X8HROC4E0
start_atstring
Example:2019-01-01T00: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
next_billing_atstring
Example:2019-01-01T00: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-03T19:04:24Z
updated_atstring
Example:2018-04-03T19:04:24Z
customerobject
Show Child Parameters
cardobject
Show Child Parameters
planobject
Show Child Parameters
itemsarray[object]
Show Child Parameters
patch/subscriptions/{subscription_id}/start-at
Authentication
Path Parameters
Body
{
"start_at": "2019-01-01"
}
application/json