Lista todos los planes de suscripción

GET

subscription

plan

curl "https://api.therius.io/v1/subscription/plan?merchantCode=MERCHANT_001&country=US" \
  -H "Authorization: Bearer prv_production_your_key_here"

[
  {
    "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"
  }
]

GET /subscription/plan devuelve todos los planes de facturación de tu cuenta de comercio, incluyendo el conteo actual de suscriptores y el estado de archivo de cada plan. Usa el filtro country para ver solo los planes disponibles en un mercado específico — los planes globales (los que no tienen restricciones de país) siempre se incluyen en los resultados filtrados.

Solicitud

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

Headers

string

requerido

Bearer prv_production_xxx (producción) o Bearer prv_sandbox_xxx (sandbox) — tu clave de API privada de comercio.

Parámetros de consulta

string

requerido

Tu identificador de cuenta de comercio. Requerido si tu clave está asociada con varias cuentas de comercio.

string

Código de país ISO 3166-1 alpha-2 para filtrar planes por disponibilidad, p. ej. "BR". Devuelve planes donde availableCountries incluye el código dado, más todos los planes disponibles globalmente. Omítelo para devolver todos los planes independientemente de las restricciones de país.

Respuesta

Devuelve un array de objetos de plan. Cada objeto incluye todos los campos establecidos en el momento de la creación más los siguientes campos calculados:

integer

El ID entero único del plan.

integer

Número de suscriptores actualmente activos o en prueba en este plan.

boolean

Si el plan acepta nuevos suscriptores. Establécelo en false vía Actualizar plan para desactivarlo de forma suave.

string

Timestamp ISO 8601 de cuándo se archivó el plan, o null si no está archivado. Los planes archivados siguen apareciendo en los resultados de lista.

curl "https://api.therius.io/v1/subscription/plan?merchantCode=MERCHANT_001&country=US" \
  -H "Authorization: Bearer prv_production_your_key_here"

Los planes archivados se incluyen en la respuesta con un deletedAt no nulo. Fíltralos del lado del cliente si solo quieres los planes actualmente abiertos para inscripción.

Autorizaciones

Authorization

string

header

requerido

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.

Respuesta

200 - application/json

List of plans

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.

Opciones disponibles:

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 "https://api.therius.io/v1/subscription/plan?merchantCode=MERCHANT_001&country=US" \
  -H "Authorization: Bearer prv_production_your_key_here"

[
  {
    "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"
  }
]

Pagos

Tokenización

Suscripciones

Planes

Sesión del SDK

Lista todos los planes de suscripción

Solicitud

Headers

Parámetros de consulta

Respuesta

Autorizaciones

Parámetros de consulta

Respuesta

​Solicitud

​Headers

​Parámetros de consulta

​Respuesta

Autorizaciones

Parámetros de consulta

Respuesta

Solicitud

Headers

Parámetros de consulta

Respuesta