Skip to main content
GET
/
organizations
/
{organizationId}
/
subscriptions
Obter Assinatura
curl --request GET \
  --url https://api.example.com/organizations/{organizationId}/subscriptions \
  --header 'Authorization: <authorization>'
{
  "statusCode": 400,
  "message": "Bad Request Error",
  "errors": [{"message": "required", "path": "field"}]
}
Retorna a assinatura ativa da organizacao. 
curl https://api.awsales.io/studio/organizations/ORG_ID/subscriptions \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
Requer permissao subscription:read.

​
Cabecalhos

​
Authorization
string
required
Token bearer.

​
Parametros de Rota

​
organizationId
string
required
O UUID da organizacao.

​
Resposta

​
subscriptionId
string
O identificador unico da assinatura.
​
organizationId
string
O UUID da organizacao.
​
planId
string
O ID do plano.
​
planIntervalId
string
O ID do intervalo do plano.
​
externalPlanRef
string | null
Referencia externa para a assinatura do plano.
​
externalFeeRef
string | null
Referencia externa para taxas.
​
currency
string
O codigo da moeda (ex.: BRL, USD).
​
status
string
O status da assinatura. Um de: ACTIVE, PAST_DUE, PAUSED, CANCELLATION_PENDING, CANCELLED.
​
pastDueReason
string | null
Razao pela qual a assinatura esta em atraso.
​
pastDueAt
string | null
Timestamp ISO 8601 de quando a assinatura ficou em atraso.
​
pausedBy
string | null
Usuario que pausou a assinatura.
​
pausedAt
string | null
Timestamp ISO 8601 de quando a assinatura foi pausada.
​
cancelledBy
string | null
Usuario que cancelou a assinatura.
​
cancelledAt
string | null
Timestamp ISO 8601 de quando a assinatura foi cancelada.
​
coupons
array
Cupons aplicados.
​
createdBy
string
Usuario que criou a assinatura.
​
createdAt
string
Timestamp de criacao ISO 8601.
​
updatedBy
string
Usuario que atualizou a assinatura por ultimo.
​
updatedAt
string
Timestamp da ultima atualizacao 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