The Subscription object
A Rutter Subscription represents a recurring purchase placed on the merchant's store. Every subscription is linked to multiple Products and Variants that represent the items contained within the subscription.
Properties
id
stringThe Rutter generated unique ID of the subscription.
platform_id
stringThe platform specific ID of the subscription.
platform_customer_id
stringnullableoptionaliso_currency_code
stringThe ISO 4217 currency code of the subscription.
status
enumStatus of subscription. Possible values are: active
, in_trial
, canceled
, paused
, unknown
items
arrayoptionalitems
attributescreated_at
stringThe ISO 8601 timestamp that the subscription was created.
updated_at
stringThe ISO 8601 timestamp that the subscription was last updated.
{
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"platform_customer_id": "12345678",
"iso_currency_code": "USD",
"status": "active",
"items": [
{
"platform_id": "12345678",
"interval": "month",
"interval_count": 1,
"quantity": 2,
"amount": 24.68,
"unit_amount": 12.34
}
],
"created_at": "2023-01-02T02:34:56.000Z",
"updated_at": "2023-01-02T02:34:56.000Z"
}
List Subscriptions
GET /subscriptionsRequest Parameters
access_token
stringqueryThe access token of the connection.
cursor
stringoptionalqueryThe cursor to use for pagination. This value is passed in from next_cursor
field in a previous request.
force_fetch
enumoptionalqueryForce a response even if the underlying connection hasn't finished the initial sync.
limit
integeroptionalqueryThe limit on the number of entities returned.
updated_at_max
integeroptionalqueryUnix Timestamp in milliseconds representing the maximum updated_at datetime to fetch entities from.
updated_at_min
integeroptionalqueryUnix Timestamp in milliseconds representing the minimum updated_at datetime to fetch entities from.
Response Body
connection
objectoptionalconnection
attributessubscriptions
arraysubscriptions
attributesnext_cursor
stringnullable{
"connection": {
"id": "00000000-0000-0000-0000-000000000000",
"orgId": "00000000-0000-0000-0000-000000000000",
"platform": "SHOPIFY"
},
"subscriptions": [
{
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"platform_customer_id": "12345678",
"iso_currency_code": "USD",
"status": "active",
"items": [
{
"platform_id": "12345678",
"interval": "month",
"interval_count": 1,
"quantity": 2,
"amount": 24.68,
"unit_amount": 12.34
}
],
"created_at": "2023-01-02T02:34:56.000Z",
"updated_at": "2023-01-02T02:34:56.000Z"
}
],
"next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="
}