Subscriptions

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

idstring

The Rutter generated unique ID of the subscription.

platform_idstring

The platform specific ID of the subscription.

platform_customer_idstringnullableOptional

The platform specific ID of the customer linked to the subscription.

iso_currency_codestring

The ISO 4217 currency code of the subscription.

statusenum

Status of subscription. Possible values are: active, in_trial, canceled, paused, unknown

One ofactive, in_trial, canceled, paused, or unknown.

itemsarrayOptional

An array of subscription items linked to the subscription.

Show items attributes

created_atstring

The ISO 8601 timestamp that the subscription was created.

updated_atstring

The ISO 8601 timestamp that the subscription was last updated.

platform_dataobjectOptional

The raw platform data corresponding to the Rutter object.

Endpoints

GET

/subscriptions

List Subscriptions

GEThttps://production.rutterapi.com/versioned/subscriptions

Request Parameters

access_tokenstringqueryRequired

The access token of the connection.

cursorstringqueryOptional

Used to paginate to the next batch of objects. Should be a copy of the next_cursor value from the previous response.

limitintegerqueryOptional

Used to limit the number of returned objects. Defaults to 50.

expandenumqueryOptional

Include platform specific data (includes additional fields not provided by the Rutter object).

Must beplatform_data.

created_at_maxintegerqueryOptional

Used to filter objects with a created_at value less than or equal to the supplied value. Should be a Unix time in milliseconds.

created_at_minintegerqueryOptional

Used to filter objects with a created_at value greater than or equal to the supplied value. Should be a Unix time in milliseconds.

updated_at_maxintegerqueryOptional

Used to filter objects with a updated_at value less than or equal to the supplied value. Should be a Unix time in milliseconds.

updated_at_minintegerqueryOptional

Used to filter objects with a updated_at value greater than or equal to the supplied value. Should be a Unix time in milliseconds.

force_fetchenumqueryOptional

Used to force a response even if the underlying connection has not finished its initial sync.

One oftrue or false.

Response Body

200

Example Response Body

JSON

1{
2  "subscriptions": [
3    {
4      "id": "00000000-0000-0000-0000-000000000000",
5      "platform_id": "12345678",
6      "platform_customer_id": "12345678",
7      "iso_currency_code": "USD",
8      "status": "active",
9      "items": [
10        {
11          "platform_id": "12345678",
12          "interval": "month",
13          "interval_count": 1,
14          "quantity": 2,
15          "amount": 24.68,
16          "unit_amount": 12.34
17        }
18      ],
19      "created_at": "2023-01-02T02:34:56.000Z",
20      "updated_at": "2023-01-02T02:34:56.000Z"
21    }
22  ],
23  "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=",
24  "connection": {
25    "id": "00000000-0000-0000-0000-000000000000",
26    "orgId": "00000000-0000-0000-0000-000000000000",
27    "platform": "SHOPIFY"
28  }
29}

Have questions?

Contact support for personalized guidance.

Contact support