Skip to main content
GET
GET /subscription/plan returns all billing plans for your merchant account, including the current subscriber count and archive status for each plan. Use the country filter to see only plans available in a specific market — global plans (those without country restrictions) are always included in filtered results.

​
Request

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

​
Headers

​
string
required
Bearer prv_production_xxx (production) or Bearer prv_sandbox_xxx (sandbox) — your merchant private API key.

​
Query Parameters

​
string
required
Your merchant account identifier. Required if your key is associated with multiple merchant accounts.
​
string
ISO 3166-1 alpha-2 country code to filter plans by availability, e.g. "BR". Returns plans where availableCountries includes the given code, plus all globally available plans. Omit to return all plans regardless of country restrictions.

​
Response

Returns an array of plan objects. Each object includes all fields set at creation time plus the following computed fields:
​
integer
The plan’s unique integer ID.
​
integer
Number of currently active or trialing subscribers on this plan.
​
boolean
Whether the plan is accepting new subscribers. Set to false via Update Plan to soft-deactivate.
​
string
ISO 8601 timestamp of when the plan was archived, or null if not archived. Archived plans still appear in list results.
Archived plans are included in the response with a non-null deletedAt. Filter them out client-side if you only want plans currently open for enrollment.

Authorizations

​
Authorization
string
header
required

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

Query Parameters

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

Response

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.

Available options:
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>