Atualize um plano de assinatura

PATCH

subscription

plan

{id}

curl -X PATCH https://api.therius.io/v1/subscription/plan/42 \
  -H "Authorization: Bearer prv_production_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "merchantCode": "MERCHANT_001",
    "name": "Pro Monthly (Revised)",
    "isActive": false
  }'

{
  "id": 123,
  "merchantId": 123,
  "name": "<string>",
  "description": "<string>",
  "interval": "day",
  "intervalCount": 123,
  "amount": 123,
  "currency": "<string>",
  "exponent": 123,
  "trialPeriodDays": 123,
  "introAmount": 123,
  "introBillingCycles": 123,
  "maxBillingCycles": 123,
  "availableCountries": [
    "<string>"
  ],
  "isActive": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

PATCH /subscription/plan/{id} atualiza os campos mutáveis de um plano existente. Você pode renomeá-lo, atualizar a descrição dele, alternar o status ativo dele para parar de aceitar novos assinantes, ou ajustar os países onde ele está disponível — tudo sem afetar os assinantes existentes.

amount, interval, intervalCount e currency são imutáveis e não podem ser alterados por este endpoint. Para mudar o preço ou a cadência de faturamento, crie um novo plano usando POST /subscription/plan e migre os assinantes usando change-plan.

Inclua apenas os campos que você quer mudar — os omitidos ficam inalterados (veja o painel de parâmetros acima para a lista completa; availableCountries é uma substituição completa, não uma mesclagem). Devolve 200 OK com o objeto de plano atualizado completo.

Erros

Código	Significado
`404`	Plano não encontrado.
`422`	Erro de validação — p. ex. um código de país não reconhecido ou uma tentativa de mutar um campo imutável.

curl -X PATCH https://api.therius.io/v1/subscription/plan/42 \
  -H "Authorization: Bearer prv_production_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "merchantCode": "MERCHANT_001",
    "name": "Pro Monthly (Revised)",
    "isActive": false
  }'

Autorizações

Authorization

string

header

obrigatório

Your secret API key: Bearer prv_production_xxx (production) or Bearer prv_sandbox_xxx (sandbox).

Parâmetros de caminho

string

obrigatório

Corpo

application/json

merchantCode

string

obrigatório

Your merchant account identifier.

name

string

New plan name.

description

string

New description.

isActive

boolean

Set false to stop the plan accepting new subscribers. amount and interval cannot be changed - create a new plan and use change-plan instead.

availableCountries

string[]

Replacement list of ISO 3166-1 alpha-2 codes. Send [] to make the plan global.

Resposta

200 - application/json

Updated plan

A reusable billing plan. amount is a flat integer in the currency minor units (with separate currency + exponent) - not an Amount object.

integer

The plan unique integer ID.

merchantId

integer

The merchant account that owns the plan.

name

string

description

string

interval

enum<string>

Billing interval unit. Immutable after creation.

Opções disponíveis:

day,

week,

month,

year

intervalCount

integer

Number of interval units between charges - month + 3 bills quarterly.

amount

integer

Recurring charge in the currency minor units (e.g. 2999 = $29.99 at exponent 2). Immutable after creation.

currency

string

ISO 4217 currency code. Immutable after creation.

exponent

integer

Decimal places for amount / introAmount - 2 for USD, 0 for JPY.

trialPeriodDays

integer

Free-trial length in days before the first charge. 0 for no trial.

introAmount

integer

Introductory charge in minor units for the first introBillingCycles cycles, if set.

introBillingCycles

integer

How many initial cycles are billed at introAmount before the rate reverts to amount.

maxBillingCycles

integer

Total cycles after which the subscription auto-completes. 0 = open-ended.

availableCountries

string[]

ISO 3166-1 alpha-2 codes the plan is offered in. Empty = available everywhere.

isActive

boolean

Whether the plan accepts new subscribers. Existing subscriptions are unaffected when this is false.

createdAt

string<date-time>

updatedAt

string<date-time>

curl -X PATCH https://api.therius.io/v1/subscription/plan/42 \
  -H "Authorization: Bearer prv_production_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "merchantCode": "MERCHANT_001",
    "name": "Pro Monthly (Revised)",
    "isActive": false
  }'

{
  "id": 123,
  "merchantId": 123,
  "name": "<string>",
  "description": "<string>",
  "interval": "day",
  "intervalCount": 123,
  "amount": 123,
  "currency": "<string>",
  "exponent": 123,
  "trialPeriodDays": 123,
  "introAmount": 123,
  "introBillingCycles": 123,
  "maxBillingCycles": 123,
  "availableCountries": [
    "<string>"
  ],
  "isActive": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Pagamentos

Tokenização

Assinaturas

Planos

Sessão do SDK

Atualize um plano de assinatura

Erros

Autorizações

Parâmetros de caminho

Corpo

Resposta

​Erros

Autorizações

Parâmetros de caminho

Corpo

Resposta

Erros