Skip to main content
GET
Get subscription details

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

subscription_id
string<MeteroidId>
required

Subscription ID

Example:

"sub_7n42DGM5Tflk9n8mt7Fhc7"

Response

Details of subscription

add_ons
object[]
required
applied_coupons
object[]
required
auto_advance_invoices
boolean
required
billing_day_anchor
integer<int32>
required
charge_automatically
boolean
required
components
object[]
required
created_at
string<date-time>
required

When the subscription was created

currency
enum<string>
required
Available options:
AED,
AFN,
ALL,
AMD,
ANG,
AOA,
ARS,
AUD,
AWG,
AZN,
BAM,
BBD,
BDT,
BGN,
BHD,
BIF,
BMD,
BND,
BOB,
BRL,
BSD,
BTN,
BWP,
BYN,
BZD,
CAD,
CDF,
CHF,
CLP,
CNH,
CNY,
COP,
CRC,
CUC,
CUP,
CVE,
CZK,
DJF,
DKK,
DOP,
DZD,
EGP,
ERN,
ETB,
EUR,
FJD,
FKP,
GBP,
GEL,
GHS,
GIP,
GMD,
GNF,
GTQ,
GYD,
HKD,
HNL,
HRK,
HTG,
HUF,
IDR,
ILS,
INR,
IQD,
IRR,
ISK,
JMD,
JOD,
JPY,
KES,
KGS,
KHR,
KMF,
KPW,
KRW,
KWD,
KYD,
KZT,
LAK,
LBP,
LKR,
LRD,
LSL,
LYD,
MAD,
MDL,
MGA,
MKD,
MMK,
MNT,
MOP,
MRU,
MUR,
MVR,
MWK,
MXN,
MYR,
MZN,
NAD,
NGN,
NIO,
NOK,
NPR,
NZD,
OMR,
PAB,
PEN,
PGK,
PHP,
PKR,
PLN,
PYG,
QAR,
RON,
RSD,
RUB,
RWF,
SAR,
SBD,
SCR,
SDG,
SEK,
SGD,
SHP,
SLL,
SOS,
SRD,
SSP,
STD,
STN,
SVC,
SYP,
SZL,
THB,
TJS,
TMT,
TND,
TOP,
TRY,
TTD,
TWD,
TZS,
UAH,
UGX,
USD,
UYU,
UZS,
VES,
VND,
VUV,
WST,
XAF,
XCD,
XOF,
XPF,
YER,
ZAR,
ZMW,
ZWL
Example:

"EUR"

current_period_start
string<date>
required

Current billing period start date

custom_properties
any
required

User-defined custom property values, keyed by definition key.

customer_id
string<MeteroidId>
required
Example:

"cus_7n42DGM5Tflk9n8mt7Fhc7"

customer_name
string
required
id
string<MeteroidId>
required
Example:

"sub_7n42DGM5Tflk9n8mt7Fhc7"

mrr_cents
integer<int64>
required

Monthly recurring revenue in cents

Required range: x >= 0
net_terms
integer<int32>
required

Payment terms in days (0 = due on issue)

Required range: x >= 0
period
enum<string>
required

Billing period (monthly, annual, etc.)

Available options:
MONTHLY,
QUARTERLY,
SEMIANNUAL,
ANNUAL
plan_id
string<MeteroidId>
required
Example:

"plan_7n42DGM5Tflk9n8mt7Fhc7"

plan_name
string
required
plan_version
integer<int32>
required
Required range: x >= 0
plan_version_id
string<MeteroidId>
required
Example:

"plv_7n42DGM5Tflk9n8mt7Fhc7"

start_date
string<date>
required

When the subscription contract starts (benefits apply from this date)

status
enum<string>
required
Available options:
PENDING_ACTIVATION,
PENDING_CHARGE,
TRIAL_ACTIVE,
ACTIVE,
TRIAL_EXPIRED,
PAUSED,
SUSPENDED,
CANCELLED,
ABORTED,
COMPLETED,
SUPERSEDED,
ERRORED
activated_at
string<date-time> | null

When the subscription was activated (first payment or activation condition met)

billing_start_date
string<date> | null

When billing started (after any trial period)

checkout_url
string | null
current_period_end
string<date> | null

Current billing period end date

customer_alias
string | null
end_date
string<date> | null

When the subscription ends (if set)

entitlements
object[]
invoice_memo
string | null

Default memo for invoices

minimum_commitment
object | null

Materialized minimum-commitment floor on this subscription (plan snapshot or operator override). Read-only here — set it at creation, or change it via a subscription amendment.

payment_methods_config
object

Online (card/direct debit), BankTransfer, or External.

purchase_order
string | null
trial_duration
integer<int32> | null

Trial duration in days

Required range: x >= 0