Sign in
Subscriptions

Retrieve a subscription's history

get/subscriptions/{id}/history

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. Response will return an array of 0 or more history entries

idinteger

The SamCart ID for the subscription history record

subscription_idinteger

The SamCart ID for the subscription

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

The status of the subscription

sourcestring

The source of the change

typestring

The type of change

change_datestring date-time

The UTC date and time that the change was made

Example response

[
  {
    "id": 1337,
    "subscription_id": 1001,
    "new_status": "active",
    "source": "dashboard",
    "type": "status",
    "change_date": "2021-03-08 00:18:35"
  }
]

Changes

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