Primeiros Passos
Auth & Identidade
Gestão de Acesso
Criar Assinatura
curl --request POST \
--url https://api.example.com/organizations/{organizationId}/subscriptions \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"planId": "<string>",
"planIntervalId": "<string>",
"paymentMethodId": "<string>",
"coupon": {
"code": "<string>"
}
}
'{
"statusCode": 400,
"message": "Bad Request Error",
"errors": [{"message": "required", "path": "field"}]
}
Subscriptions
Criar Assinatura
Criar uma nova assinatura para a organizacao selecionando um plano, intervalo de cobranca e metodo de pagamento.
POST
/
organizations
/
{organizationId}
/
subscriptions
Criar Assinatura
curl --request POST \
--url https://api.example.com/organizations/{organizationId}/subscriptions \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"planId": "<string>",
"planIntervalId": "<string>",
"paymentMethodId": "<string>",
"coupon": {
"code": "<string>"
}
}
'{
"statusCode": 400,
"message": "Bad Request Error",
"errors": [{"message": "required", "path": "field"}]
}
Cria uma nova assinatura.
curl -X POST https://api.awsales.io/studio/organizations/ORG_ID/subscriptions \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"planId": "019525fd-6b2c-7a1e-9d4f-3c5e7a9b1d3f",
"planIntervalId": "019525fd-7e40-7c5a-b2d8-4e6f8a0c2e4a",
"paymentMethodId": "pm_abc123",
"coupon": {
"code": "WELCOME10"
}
}'
Uma organizacao pode ter apenas uma assinatura ativa. Tentar criar uma segunda assinatura retornara
409 subscription.active_subscription_exists.Requer permissao
subscription:write.Cabecalhos
Token bearer.
Parametros de Rota
O UUID da organizacao.
Corpo da Requisicao
O ID do plano para assinar.
O ID do intervalo do plano (determina a frequencia e o valor da cobranca).
O ID do metodo de pagamento para cobranca.
Cupom opcional a aplicar na criacao da assinatura.
Show coupon properties
Show coupon properties
O codigo do cupom.
Resposta
O ID da assinatura.
O UUID da organizacao.
O ID do plano.
O ID do intervalo do plano.
Referencia externa para a assinatura do plano.
Referencia externa para taxas.
O codigo da moeda.
O status da assinatura.
Razao pela qual a assinatura esta em atraso.
Timestamp ISO 8601 de quando a assinatura ficou em atraso.
Usuario que pausou a assinatura.
Timestamp ISO 8601 de quando a assinatura foi pausada.
Usuario que cancelou a assinatura.
Timestamp ISO 8601 de quando a assinatura foi cancelada.
Cupons aplicados.
Usuario que criou a assinatura.
Timestamp de criacao ISO 8601.
Usuario que atualizou a assinatura por ultimo.
Timestamp da ultima atualizacao ISO 8601.
{
"statusCode": 400,
"message": "Bad Request Error",
"errors": [{"message": "required", "path": "field"}]
}
Codigos de Erro
| Status | Codigo | Descricao |
|---|---|---|
400 | validation_error | Entrada invalida ou campos obrigatorios ausentes |
401 | unauthorized | Autenticacao ausente ou invalida |
403 | forbidden | Permissoes insuficientes |
404 | organization.not_found | Organizacao nao encontrada |
409 | subscription.active_subscription_exists | Organizacao ja possui uma assinatura ativa |
409 | coupon.not_available | Cupom e invalido, expirado ou esgotado |
500 | internal_server_error | Ocorreu um erro inesperado |
⌘I
Assistant
Responses are generated using AI and may contain mistakes.