Sign in
Subscriptions

Retrieve all subscriptions

get/subscriptions

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.

rebilling_at_minstring date-time

Filter by rebilling 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.

rebilling_at_maxstring date-time

Filter by rebilling 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.

canceled_at_minstring date-time

Filter by canceled 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.

canceled_at_maxstring date-time

Filter by canceled 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.

test_modeboolean

Filter by test mode

status'active' | 'canceled' | 'delinquent' | 'completed' | 'paused' | 'invalid_processor' | 'sca_required' | 'deleted'

Filter subscriptions by status

type'limited_subscription' | 'recurring_subscription'

Filter subscriptions by type

offsetinteger

The offset value used to paginate through a list of entries. If the dir query parameter is prev then the offset will be the id of the first record of the data set otherwise the offset will be the id of the last record

limitinteger

An optional limit for the number of entries on a page with a maximum value of 100. Default value is 100 if not provided.

dir'next' | 'prev'

The direction to paginate the next set of data. If dir is prev the page will return a data set before the offset otherwise the data set will be after the offset. Default value is next if not provided.

Response

Successful operation. Response will return an array of 0 or more subscriptions

Example response

{
  "data": [
    {
      "id": 1337,
      "customer_id": 1234,
      "affiliate_id": 1001,
      "order_id": 1001,
      "product_id": 1001,
      "sku": "sku123",
      "status": "active",
      "type": "recurring_subscription",
      "product_name": "Cool Product",
      "internal_product_name": "Cool Product",
      "initial_price": {
        "subtotal": 10000,
        "taxes": 500,
        "shipping": 300,
        "total": 9800
      },
      "recurring_price": {
        "subtotal": 10000,
        "taxes": 500,
        "shipping": 300,
        "total": 10800
      },
      "coupon": {
        "charge_instance": "one_time",
        "code": "summersale",
        "type": "flat_rate",
        "discount_percentage": 10
      },
      "cancel_schedule": {
        "status": "scheduled",
        "cancel_date": "2021-03-08 00:18:35"
      },
      "processor_name": "Stripe",
      "test_mode": true,
      "created_at": "2021-03-08 00:18:35",
      "start_date": "2021-03-08 00:18:35",
      "end_date": "2021-03-08 00:18:35",
      "next_rebilling_date": "2021-04-08 00:18:35",
      "total_failed_charges": 1,
      "subscription_interval": "monthly",
      "stripe_plan_id": "plan_abc123"
    }
  ],
  "pagination": {
    "next": "https://example.samcart.com/v1/example?offset=1337&dir=next"
  }
}

Changes

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