Skip to main content
GET
/
organizations
/
{organizationId}
/
subscriptions
/
upcoming-invoice
Obter Proxima Fatura
curl --request GET \
  --url https://api.example.com/organizations/{organizationId}/subscriptions/upcoming-invoice \
  --header 'Authorization: <authorization>'
{
  "statusCode": 400,
  "message": "Bad Request Error",
  "errors": [{"message": "required", "path": "field"}]
}
Retorna uma previa da proxima fatura. 
curl https://api.awsales.io/studio/organizations/ORG_ID/subscriptions/upcoming-invoice \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
Use este endpoint para mostrar aos usuarios um detalhamento da proxima cobranca antes de ser emitida. A previa inclui itens, descontos e o valor total a pagar.
Requer permissao subscription:read.

​
Cabecalhos

​
Authorization
string
required
Token bearer.

​
Parametros de Rota

​
organizationId
string
required
O UUID da organizacao.

​
Resposta

​
invoiceId
string
O identificador unico da fatura.
​
organizationId
string
O UUID da organizacao.
​
subscriptionId
string
O ID da assinatura.
​
paymentMethod
string|null
O tipo de metodo de pagamento.
​
card
object|null
Detalhes do cartao, se aplicavel.
​
boleto
object|null
Detalhes do boleto, se aplicavel.
​
currency
string
O codigo da moeda.
​
totalAmount
integer
O valor total em centavos.
​
discountAmount
integer
O valor do desconto em centavos.
​
payableAmount
integer
O valor a pagar em centavos.
​
lines
array
Os itens da fatura.
​
discounts
array
Os descontos aplicados.
​
billingThreshold
object|null
O limiar de cobranca associado a fatura.
​
status
string
O status da fatura.
​
dueDate
string
A data de vencimento (ISO 8601).
{
  "statusCode": 400,
  "message": "Bad Request Error",
  "errors": [{"message": "required", "path": "field"}]
}

​
Codigos de Erro

StatusCodigoDescricao
400validation_errorEntrada invalida ou campos obrigatorios ausentes
401unauthorizedAutenticacao ausente ou invalida
403forbiddenPermissoes insuficientes
404organization.not_foundOrganizacao nao encontrada
404subscription.not_foundAssinatura nao encontrada
500internal_server_errorOcorreu um erro inesperado