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

idstringRequired

The Rutter generated unique ID of the subscription.

platform_idstringRequired

The platform specific ID of the subscription.

platform_customer_idstringnullable

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

iso_currency_codestringRequired

The ISO 4217 currency code of the subscription.

statusenumRequired

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

One ofactivein_trialcanceledpaused, or unknown.
itemsarray

An array of subscription items linked to the subscription.

Show items attributes
created_atstringRequired

The ISO 8601 timestamp that the subscription was created.

updated_atstringRequired

The ISO 8601 timestamp that the subscription was last updated.

Endpoints
GET
/subscriptions

List Subscriptions

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

Request Parameters

    access_tokenstringqueryRequired

    The access token of the connection.

    cursorstringquery

    The cursor to use for pagination. This value is passed in from next_cursor field in a previous request.

    force_fetchenumquery

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

    One oftrue or false.
    limitintegerquery

    The limit on the number of entities returned.

    updated_at_maxintegerquery

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

    updated_at_minintegerquery

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

Response Body

    connectionobject
    Show connection attributes
    subscriptionsarrayRequired
    Show subscriptions attributes
    next_cursorstringnullableRequired
Support by integration
  • Chargebee
    Chargebee
  • Chargify
    Chargify
  • Recurly
    Recurly
  • Stripe
    Stripe
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