Get subscription summary
Retrieve a subscription without its components, add-ons, coupons and entitlements: the same shape as list items, for callers that only need status and billing dates.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Subscription ID
"sub_7n42DGM5Tflk9n8mt7Fhc7"
Response
Subscription summary
If false, invoices will stay in Draft until manually reviewed and finalized. Default to true.
Automatically try to charge the customer's configured payment method on finalize.
When the subscription was created
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 "EUR"
Current billing period start date
User-defined custom property values, keyed by definition key.
"cus_7n42DGM5Tflk9n8mt7Fhc7"
"sub_7n42DGM5Tflk9n8mt7Fhc7"
Monthly recurring revenue in cents
x >= 0Payment terms in days (0 = due on issue)
x >= 0Billing period (monthly, annual, etc.)
MONTHLY, QUARTERLY, SEMIANNUAL, ANNUAL "plan_7n42DGM5Tflk9n8mt7Fhc7"
x >= 0"plv_7n42DGM5Tflk9n8mt7Fhc7"
When the subscription contract starts (benefits apply from this date)
PENDING_ACTIVATION, PENDING_CHARGE, TRIAL_ACTIVE, ACTIVE, TRIAL_EXPIRED, PAUSED, SUSPENDED, CANCELLED, ABORTED, COMPLETED, SUPERSEDED, ERRORED The subscription's prices are quoted tax-included (snapshotted from its plan version).
When the subscription was activated (first payment or activation condition met)
When billing started (after any trial period)
Current billing period end date
When the subscription ends (if set)
Default memo for invoices
Payment methods configuration (Online, BankTransfer, or External)
- Option 1
- Option 2
- Option 3
Trial duration in days
x >= 0