Skip to main content
GET
GET /subscription/plan devolve todos os planos de faturamento da sua conta de lojista, incluindo a contagem atual de assinantes e o status de arquivamento de cada plano. Use o filtro country para ver apenas os planos disponíveis em um mercado específico — os planos globais (os sem restrições de país) são sempre incluídos nos resultados filtrados.

​
Requisição

URL base: https://api.therius.io/v1 Endpoint: GET /subscription/plan

​
Headers

​
string
obrigatório
Bearer prv_production_xxx (produção) ou Bearer prv_sandbox_xxx (sandbox) — a sua chave de API privada de lojista.

​
Parâmetros de consulta

​
string
obrigatório
O seu identificador de conta de lojista. Obrigatório se a sua chave estiver associada a várias contas de lojista.
​
string
Código de país ISO 3166-1 alpha-2 para filtrar planos por disponibilidade, p. ex. "BR". Devolve planos onde availableCountries inclui o código dado, mais todos os planos disponíveis globalmente. Omita para devolver todos os planos independentemente das restrições de país.

​
Resposta

Devolve um array de objetos de plano. Cada objeto inclui todos os campos definidos no momento da criação mais os seguintes campos calculados:
​
integer
O ID inteiro único do plano.
​
integer
Número de assinantes atualmente ativos ou em teste neste plano.
​
boolean
Se o plano aceita novos assinantes. Defina como false via Atualizar plano para desativá-lo de forma suave.
​
string
Timestamp ISO 8601 de quando o plano foi arquivado, ou null se não estiver arquivado. Os planos arquivados continuam aparecendo nos resultados de lista.
Os planos arquivados são incluídos na resposta com um deletedAt não nulo. Filtre-os no lado do cliente se você quiser apenas os planos atualmente abertos para inscrição.

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 consulta

​
merchantCode
string

Your merchant account identifier. Required if the key maps to more than one merchant account.

​
country
string

ISO 3166-1 alpha-2 code - returns plans available in that country plus all globally-available plans.

Resposta

200 - application/json

List of plans

​
id
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>