Skip to main content
PATCH
Configurar o limite de gasto mensal de um produto (admin)

Authorizations

Authorization
string
header
required

OAuth2 Authorization Code flow

Body

application/json
productSlug
string
required

Slug do produto ao qual o limite se aplica

Example:

"catalog_avulsas"

spendLimit
integer | null
required

Limite de gasto mensal cobrável em centavos (BRL). null remove o limite (ilimitado).

Required range: x >= 0
Example:

50000

Response

200 - application/json
object
enum<string>
required

Object type

Available options:
subscription
Example:

"subscription"

id
string | null
required

ID da assinatura no Stripe

Example:

"sub_xxx"

status
string
required

Status da assinatura

Example:

"active"

hasActiveSubscription
boolean
required

Se a assinatura está ativa

Example:

true

currentPeriodStart
string<date-time> | null
required

Início do período atual

currentPeriodEnd
string<date-time> | null
required

Fim do período atual

cancelAtPeriodEnd
boolean
required

Cancelamento ao fim do período

Example:

false

trialEnd
string<date-time> | null
required

Fim do trial

currentBillTotal
number
required

Total atual da fatura em aberto/próxima fatura em centavos

Example:

9900

currentPlanTotal
number
required

Parcela atual de plano da fatura em aberto/próxima fatura em centavos

Example:

7900

currentExcessTotal
number
required

Parcela atual excedente da fatura em aberto/próxima fatura em centavos

Example:

2000

creditGrants
object[]
required

Credit grants globais aplicáveis a produtos medidos

trialDaysRemaining
integer | null
required

Dias restantes de trial

Example:

7

defaultPaymentMethod
string | null
required

Método de pagamento padrão

Example:

"Cartão •••• 4242"

products
object[]
required

Produtos contratados com uso

addons
object[]
required

Add-ons disponíveis

billingInterval
string
required

Intervalo de cobrança

Example:

"month"

pastDueInvoices
object[]
required

Faturas em aberto com valor a pagar para esta assinatura

hasPastDueInvoices
boolean
required

Indica se existem faturas em aberto para esta assinatura

Example:

false

isCurrent
boolean
required

Se esta assinatura é a assinatura corrente da organização

Example:

true

orgId
string | null
required

ID da organização associada à assinatura

name
string
required

Nome exibível da assinatura (produto principal)

Example:

"Plano por consumo"

type
enum<string>
required

Tipo de cobrança da assinatura

Available options:
metered,
credits
Example:

"metered"

editable
boolean
required

Se a conta atual pode gerenciar esta assinatura (dona do customer Stripe)

Example:

true

customerName
string | null
required

Nome do customer Stripe quando difere do customer da org atual (null se for o mesmo)

Example:

"Base39 Holding S.A."

metadata
object
required

Metadata da assinatura no Stripe

Example:
customerId
object | null

ID do customer no Stripe

Example:

"cus_xxx"

priceId
object | null

ID do preço no Stripe

Example:

"price_xxx"

credits
object | null

Saldo de créditos do período atual

productQuotas
object[]

Quotas incluídas por produto na assinatura