Cadastrar o endereço de entrega
POST
/v1/subscriptions/{id}/address
Cadastra o endereço próprio da assinatura, usado nos próximos ciclos de cobrança.
Use quando a assinatura ainda não tem endereço próprio. Se já tiver, a
resposta é 409 — nesse caso o caminho é o PATCH desta mesma rota.
O postcode é gravado sem pontuação e o state de endereço brasileiro
é gravado em maiúsculas — a resposta devolve os valores já normalizados.
TIP
O endereço é da assinatura, não do cliente: cadastrá-lo não altera o cadastro do cliente nem as outras assinaturas dele.
Um cadastro bem-sucedido dispara o webhook subscription_address_updated.
Autorizações
bearerAuth
Token Bearer do merchant obtido via POST /oauth2/token usando as
credenciais do merchant (não do app). Veja
Autenticação.
Tipo
HTTP (bearer)
Parâmetros
Parâmetros de Caminho
id*
Identificador da assinatura.
Tipo
Obrigatóriointeger
Exemplo
10Corpo da Requisição
application/json
JSON "address": { "postcode": "01010-000", "street": "Rua São Bento", "number": "111", "complement": "Bloco 7", "district": "Centro", "city": "São Paulo", "state": "SP" }
{
}
Respostas
Endereço cadastrado.
application/json
JSON "data": { "address": { "country": "BR", "state": "SP", "city": "São Paulo", "district": "Centro", "street": "Rua São Bento", "number": "111", "complement": "Bloco 7", "postcode": "01010000" } }
{
}
POST
/v1/subscriptions/{id}/address