> ## Documentation Index
> Fetch the complete documentation index at: https://docs.therius.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Liste todos os planos de assinatura
> Liste todos os planos de faturamento da sua conta de lojista, com filtro de país opcional. Inclui a contagem de assinantes e o estado de arquivamento.
export const SchemaLangNote = ({lang}) => {
const text = ({
es: "Los nombres de campos y el esquema de solicitud/respuesta que se muestran a continuación están en inglés — se generan a partir de la especificación OpenAPI. El texto explicativo de esta página está traducido.",
pt: "Os nomes dos campos e o esquema de requisição/resposta exibidos abaixo estão em inglês — são gerados a partir da especificação OpenAPI. O texto explicativo desta página está traduzido."
})[lang] || "Field names and the request/response schema shown below are in English — they are generated from the OpenAPI specification.";
return {text};
};
`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
`Bearer prv_production_xxx` (produção) ou `Bearer prv_sandbox_xxx` (sandbox) — a sua chave de API privada de lojista.
### Parâmetros de consulta
O seu identificador de conta de lojista. Obrigatório se a sua chave estiver associada a várias contas de lojista.
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:
O ID inteiro único do plano.
Número de assinantes atualmente ativos ou em teste neste plano.
Se o plano aceita novos assinantes. Defina como `false` via [Atualizar plano](/api-reference/plans/update) para desativá-lo de forma suave.
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.
```bash cURL theme={"dark"}
curl "https://api.therius.io/v1/subscription/plan?merchantCode=MERCHANT_001&country=US" \
-H "Authorization: Bearer prv_production_your_key_here"
```
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.
## OpenAPI
````yaml GET /subscription/plan
openapi: 3.1.0
info:
title: Therius API
description: REST API for payments, subscriptions, and billing plans.
version: 1.0.0
servers:
- url: https://api.therius.io/v1
description: Production
- url: https://api-sandbox.therius.io/v1
description: Sandbox
security:
- bearerAuth: []
paths:
/subscription/plan:
get:
tags:
- Plans
summary: List all subscription plans
operationId: listPlans
parameters:
- name: merchantCode
in: query
description: >-
Your merchant account identifier. Required if the key maps to more
than one merchant account.
schema:
type: string
- name: country
in: query
description: >-
ISO 3166-1 alpha-2 code - returns plans available in that country
plus all globally-available plans.
schema:
type: string
responses:
'200':
description: List of plans
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Plan'
components:
schemas:
Plan:
type: object
description: >-
A reusable billing plan. `amount` is a flat integer in the currency
minor units (with separate `currency` + `exponent`) - not an Amount
object.
properties:
id:
type: integer
description: The plan unique integer ID.
merchantId:
type: integer
description: The merchant account that owns the plan.
name:
type: string
description:
type: string
interval:
type: string
enum:
- day
- week
- month
- year
description: Billing interval unit. Immutable after creation.
intervalCount:
type: integer
description: >-
Number of `interval` units between charges - `month` + `3` bills
quarterly.
amount:
type: integer
description: >-
Recurring charge in the currency minor units (e.g. `2999` = $29.99
at exponent 2). Immutable after creation.
currency:
type: string
description: ISO 4217 currency code. Immutable after creation.
exponent:
type: integer
description: >-
Decimal places for `amount` / `introAmount` - `2` for USD, `0` for
JPY.
trialPeriodDays:
type: integer
description: Free-trial length in days before the first charge. `0` for no trial.
introAmount:
type: integer
description: >-
Introductory charge in minor units for the first
`introBillingCycles` cycles, if set.
introBillingCycles:
type: integer
description: >-
How many initial cycles are billed at `introAmount` before the rate
reverts to `amount`.
maxBillingCycles:
type: integer
description: >-
Total cycles after which the subscription auto-completes. `0` =
open-ended.
availableCountries:
type: array
items:
type: string
description: >-
ISO 3166-1 alpha-2 codes the plan is offered in. Empty = available
everywhere.
isActive:
type: boolean
description: >-
Whether the plan accepts new subscribers. Existing subscriptions are
unaffected when this is `false`.
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: >-
Your secret API key: `Bearer prv_production_xxx` (production) or `Bearer
prv_sandbox_xxx` (sandbox).
````