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.

Endpoints

GET

/subscriptions

List Subscriptions

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

Request Parameters

access_tokenstringquery

The access token of the connection.

cursorstringqueryOptional

The cursor to use for pagination. Use the value of next_cursor provided in a previous response.

force_fetchenumqueryOptional

Force a response even if the underlying connection hasn't finished the initial sync.

One oftrue or false.

limitintegerqueryOptional

The number of entities to return. Defaults to 50. Maximum is 500.

updated_at_maxintegerqueryOptional

Unix Timestamp in milliseconds representing the maximum updated_at datetime to fetch entities from.

updated_at_minintegerqueryOptional

Unix Timestamp in milliseconds representing the minimum updated_at datetime to fetch entities from.

Response Body

connectionobjectOptional

Show connection attributes

subscriptionsarray

Show subscriptions attributes

next_cursorstringnullable

Support by integration

Stripe
Chargebee
Chargify
Recurly

Example Response Body

JSON

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

Have questions?

Contact support for personalized guidance.

Contact support