Sign in
Plans

Retrieve Plan

Retrieves the details of an existing plan.

get/plans/{id}

Response

plan retrieved

accountobject nullable required

Account that sells this plan; null for standalone invoice plans.

adaptive_pricing_enabledboolean required

Whether this plan accepts local currency payments via adaptive pricing.

billing_periodnumber nullable required

Recurring billing interval in days, such as 30 for monthly or 365 for annual. null for one-time plans.

collect_taxboolean required

Whether tax is collected on purchases of this plan.

created_atstring required

When the plan was created, as an ISO 8601 timestamp.

currency'usd' | 'sgd' | 'inr' | 'aud' | 'brl' | 'cad' | 'dkk' | 'eur' | 'nok' | 'gbp' | 'sek' | 'chf' | 'hkd' | 'huf' | 'jpy' | 'mxn' | 'myr' | 'pln' | 'czk' | 'nzd' | 'aed' | 'eth' | 'ape' | 'cop' | 'ron' | 'thb' | 'bgn' | 'idr' | 'dop' | 'php' | 'try' | 'krw' | 'twd' | 'vnd' | 'pkr' | 'clp' | 'uyu' | 'ars' | 'zar' | 'dzd' | 'tnd' | 'mad' | 'kes' | 'kwd' | 'jod' | 'all' | 'xcd' | 'amd' | 'bsd' | 'bhd' | 'bob' | 'bam' | 'khr' | 'crc' | 'xof' | 'egp' | 'etb' | 'gmd' | 'ghs' | 'gtq' | 'gyd' | 'ils' | 'jmd' | 'mop' | 'mga' | 'mur' | 'mdl' | 'mnt' | 'nad' | 'ngn' | 'mkd' | 'omr' | 'pyg' | 'pen' | 'qar' | 'rwf' | 'sar' | 'rsd' | 'lkr' | 'tzs' | 'ttd' | 'uzs' | 'rub' | 'btc' | 'cny' | 'usdt' | 'kzt' | 'awg' | 'whop_usd' | 'xau' required

Three-letter ISO currency code for this plan's prices.

descriptionstring nullable required

Customer-visible plan description.

expiration_daysnumber nullable required

Access duration in days for expiration-based plans.

idstring required

Plan ID, prefixed plan_.

initial_pricenumber required

Initial purchase price in plan currency.

internal_notesstring nullable required

Private notes visible only to authorized team members.

invoiceobject nullable required

Invoice this plan was generated for; null unless created for an invoice.

member_countnumber nullable required

Active memberships through this plan, when visible to the requester.

metadataobject nullable required

Custom key-value pairs stored on the plan.

payment_method_configurationobject nullable required

Payment method configuration (enabled, disabled, include_platform_defaults); null when plan uses default settings.

plan_type'renewal' | 'one_time' required

Billing model for this plan: renewal (recurring) or one_time (single payment).

productobject nullable required

Product this plan belongs to; null for standalone plans.

purchase_urlstring required

URL where customers can purchase this plan directly.

release_method'buy_now' | 'waitlist' required

Sales method for this plan, such as buy_now or waitlist.

renewal_pricenumber required

Recurring price charged every billing period.

split_pay_required_paymentsnumber nullable required

Installment payments required before the subscription pauses.

stocknumber nullable required

Units available for purchase, when visible to the requester.

tax_type'inclusive' | 'exclusive' | 'unspecified' required

How tax is handled for this plan.

three_ds_level'mandate_challenge' | 'frictionless' | 'null' nullable required

3D Secure behavior for this plan; null inherits account default.

titlestring nullable required

Plan display name shown to customers.

trial_period_daysnumber nullable required

Free trial days before the first renewal charge. null if no trial is configured or the user has already used a trial for this plan.

unlimited_stockboolean required

Whether the plan has unlimited stock.

updated_atstring required

When the plan was last updated, as an ISO 8601 timestamp.

visibility'visible' | 'hidden' | 'archived' | 'quick_link' required

Whether the plan is visible to customers or hidden from public view.

Example response

{
  "currency": "usd",
  "custom_fields": [
    {
      "field_type": "text"
    }
  ],
  "plan_type": "renewal",
  "release_method": "buy_now",
  "tax_type": "inclusive",
  "three_ds_level": "mandate_challenge",
  "visibility": "visible"
}

Changes