Pular para o conteúdo principal
PATCH
/
workspaces
/
{workspaceId}
/
billing-accounts
/
{billingAccountId}
/
subscriptions
/
{subscriptionId}
Atualizar uma assinatura
curl --request PATCH \
  --url https://api.altostrat.io/workspaces/{workspaceId}/billing-accounts/{billingAccountId}/subscriptions/{subscriptionId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "action": "pause",
  "product_quantities": {
    "locations": 20,
    "users": 100
  },
  "add_products": {
    "sso": 1
  },
  "remove_products": [
    "sso"
  ],
  "metadata": {
    "project_id": "proj_def456"
  }
}'
{
  "id": "sub_a1b2c3d4e5f6g7h8",
  "billing_account_id": "cus_a1b2c3d4e5f6g7h8",
  "status": "active",
  "currency": "usd",
  "product_quantities": {
    "locations": {
      "price_id": "price_123abc",
      "quantity": 10,
      "interval": "month"
    },
    "users": {
      "price_id": "price_456def",
      "quantity": 50,
      "interval": "month"
    }
  },
  "metadata": {
    "order_id": "6735"
  },
  "current_period_start": "2025-10-15T00:00:00Z",
  "current_period_end": "2025-11-15T00:00:00Z",
  "created_at": "2025-10-15T12:30:00Z",
  "updated_at": "2025-10-20T09:00:00Z"
}

Authorizations

​
Authorization
string
header
required

Insira seu JWT no formato: Bearer {token}

Path Parameters

​
workspaceId
string
required

O ID do workspace.

Example:

"ws_a1b2c3d4e5f6g7h8"

​
billingAccountId
string
required

O ID da conta de faturamento, que corresponde a um ID de Cliente do Stripe (cus_...).

Example:

"cus_a1b2c3d4e5f6g7h8"

​
subscriptionId
string
required

O ID da assinatura do Stripe (sub_...).

Example:

"sub_a1b2c3d4e5f6g7h8"

Body

application/json

Especifique uma das seguintes operações: action, product_quantities, add_products ou remove_products. metadata pode ser combinado com product_quantities.

​
action
enum<string>

Realize uma ação de mudança de estado na assinatura.

Opções disponíveis:
pause,
resume,
sync
​
product_quantities
object

Substitua todas as quantidades de produtos atuais por este novo conjunto. Para remover um produto, omita-o deste objeto. Uma quantidade de 0 não é permitida; omita a chave para remover.

Example:
{ "locations": 20, "users": 100 }
​
add_products
object

Adicione novos produtos à assinatura ou aumente a quantidade dos existentes.

Example:
{ "sso": 1 }
​
remove_products
enum<string>[]

Uma lista de tipos de produtos a serem removidos da assinatura.

Example:
["sso"]
​
metadata
object

Um conjunto de pares chave-valor para armazenar com a assinatura. Será mesclado com os metadados existentes.

Example:
{ "project_id": "proj_def456" }

Response

A assinatura foi atualizada com sucesso.

​
id
string

Identificador único para a assinatura (ID da Assinatura Stripe), prefixado com sub_.

Example:

"sub_a1b2c3d4e5f6g7h8"

​
billing_account_id
string

O ID da conta de faturamento à qual esta assinatura pertence.

Example:

"cus_a1b2c3d4e5f6g7h8"

​
status
enum<string>

O status da assinatura.

Opções disponíveis:
active,
past_due,
unpaid,
canceled,
incomplete,
incomplete_expired,
trialing,
paused
Example:

"active"

​
currency
enum<string>

O código de moeda ISO de três letras para a assinatura.

Opções disponíveis:
usd,
zar,
eur,
gbp,
aud
Example:

"usd"

​
product_quantities
object

Um mapa de tipos de produtos mensuráveis para suas quantidades assinadas e detalhes de preço.

Example:
{
  "locations": {
    "price_id": "price_123abc",
    "quantity": 10,
    "interval": "month"
  },
  "users": {
    "price_id": "price_456def",
    "quantity": 50,
    "interval": "month"
  }
}
​
metadata
object

Um conjunto de pares chave-valor que você pode anexar a um objeto.

Example:
{ "order_id": "6735" }
​
current_period_start
string<date-time> | null

O início do período de faturamento atual.

Example:

"2025-10-15T00:00:00Z"

​
current_period_end
string<date-time> | null

O fim do período de faturamento atual.

Example:

"2025-11-15T00:00:00Z"

​
created_at
string<date-time> | null

O timestamp de quando a assinatura foi criada.

Example:

"2025-10-15T12:30:00Z"

​
updated_at
string<date-time> | null

O timestamp da última atualização da assinatura em nosso sistema.

Example:

"2025-10-20T09:00:00Z"