Em breve · Assinaturas
Listar assinaturas
GET/v1/subscriptionssubscriptions:readEM BREVE
Assinaturas da conta.
Este recurso ainda não está disponível. O contrato abaixo mostra como ele vai funcionar, para você planejar a integração. Hoje a chamada é recusada e nada é criado; os campos podem mudar até a liberação, que sai no changelog.
Cabeçalhos
Authorizationstringobrigatório
Bearer seguido da sua chave: gw_test_ em teste, gw_live_ em produção.
Parâmetros de consulta
limitinteger · 1–100opcional
cursorstring · até 512opcional
Resposta 200
Sucesso.
dataobject[]
14 campos
iduuid
external_idstring
product_iduuid
frequencystring
authorization_statusstring
PENDINGACTIVECANCELEDREJECTED
amount_centsinteger
cycles_paidinteger
next_charge_datedate | null
first_paymentobject | null
QR da primeira cobrança, que também pede a autorização no banco.
2 campos
copy_pastestring
qr_code_base64string | null
cyclesobject[]
6 campos
cycleinteger
statusstring
SCHEDULEDPAIDFAILEDCANCELED
amount_centsinteger
due_datedate
paid_atdatetime | null
Pagamento do ciclo.
end_to_end_idstring | null
metadataobject · até 20 chaves
Pares chave-valor seus, até 2 KB.
authorized_atdatetime | null
Autorização no banco.
canceled_atdatetime | null
Cancelamento.
created_atdatetime
next_cursorstring | null
Códigos de resposta
| HTTP | Quando acontece |
|---|---|
| 200 | Sucesso. |