Sign in
Subscriptions

Retrieve a plan for a subscription

get/subscriptions/{id}/plan

Path parameters

idinteger required

The SamCart ID for the subscription

Query parameters

created_at_minstring date-time

Filter by created at date/time at or after given value. Accepts ISO 8601/RFC 3339 format with timezone (e.g., 2025-01-16T14:30:00Z) or date-only (e.g., 2025-01-16). Date-only values use 00:00:00 UTC.

created_at_maxstring date-time

Filter by created at date/time at or before given value. Accepts ISO 8601/RFC 3339 format with timezone (e.g., 2025-01-16T14:30:00Z) or date-only (e.g., 2025-01-16). Date-only values use 23:59:59 UTC.

Response

Successful operation

idinteger

The SamCart ID for the subscription plan

product_idinteger

The SamCart ID for the product

plan_status'active' | 'archived'

The current status of the subscription plan

plan_archived_datestring date-time nullable

The UTC date and time for when the subscription plan was archived

plan_durationinteger

For a limited subscription, this indicates the number of rebills

plan_frequency'days' | 'weekly' | 'monthly' | 'quarterly' | 'yearly'

Indicates how frequently the subscription will rebill

plan_priceinteger

The recurring price of subscription exclusing tax and shipping fees

trial_periodinteger

The number of days that the subscription has for a trial

rebill_daysinteger

The number of days between each subscription rebill, used for 'days' frequency only

stripe_compatibleboolean

Indicates whether the subscription will be Stripe-managed

stripe_plan_idstring nullable

For Stripe-managed subscriptions, this is the plan ID from within Stripe

on_stripe_sandboxboolean

Indicates whether the subscription is associated with a Stripe testing environment

recurring_shippingboolean

Indicates whether the shipping prices for the subscription will be charged at every subscription rebill

Example response

{
  "id": 1337,
  "product_id": 1234,
  "plan_status": "active",
  "plan_archived_date": "2021-03-02 01:23:34",
  "plan_duration": 2,
  "plan_frequency": "days",
  "plan_price": 9825,
  "trial_period": 2,
  "rebill_days": 15,
  "stripe_compatible": true,
  "stripe_plan_id": "samcart_plan_1_12345",
  "on_stripe_sandbox": true,
  "recurring_shipping": true
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.