Subscriptions - Rutter API Reference - the Common Language for Business Data

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.

iso_currency_codestring

The ISO 4217 currency code of the subscription.

itemsarrayoptional

Show items attributes

statusenum

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

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

created_atstring

The ISO 8601 timestamp that the subscription was created.

updated_atstring

The ISO 8601 timestamp that the subscription was last updated.

platform_customer_idstringnullableoptional

Example Subscription Object

{
  "id": "00000000-0000-0000-0000-000000000000",
  "platform_id": "12345678",
  "iso_currency_code": "USD",
  "items": [
    {
      "platform_id": "12345678",
      "amount": 24.68,
      "unit_amount": 12.34,
      "quantity": 2,
      "interval": "month",
      "interval_count": 1,
      "product_id": "00000000-0000-0000-0000-000000000000",
      "variant_id": "00000000-0000-0000-0000-000000000000",
      "title": "Subscription for a Rutter shirt."
    }
  ],
  "status": "active",
  "created_at": "2023-01-02T02:34:56.000Z",
  "updated_at": "2023-01-02T02:34:56.000Z",
  "platform_customer_id": "12345678"
}

List Subscriptions

GET /subscriptions

Supported for: ChargebeeChargifyRecurlyStripe

Request Parameters

access_tokenstringquery

The access token of the connection.

cursorstringoptionalquery

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

force_fetchenumoptionalquery

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

One oftrue or false.

limitintegeroptionalquery

The limit on the number of entities returned.

updated_at_maxintegeroptionalquery

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

updated_at_minintegeroptionalquery

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

Response Body

subscriptionsA list of subscriptions

Show subscriptions attributes

connectionConnectionoptional

Show connection attributes

next_cursorstringnullable

Example Response Body

{
  "subscriptions": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "platform_id": "12345678",
      "iso_currency_code": "USD",
      "items": [
        {
          "platform_id": "12345678",
          "amount": 24.68,
          "unit_amount": 12.34,
          "quantity": 2,
          "interval": "month",
          "interval_count": 1,
          "product_id": "00000000-0000-0000-0000-000000000000",
          "variant_id": "00000000-0000-0000-0000-000000000000",
          "title": "Subscription for a Rutter shirt."
        }
      ],
      "status": "active",
      "created_at": "2023-01-02T02:34:56.000Z",
      "updated_at": "2023-01-02T02:34:56.000Z",
      "platform_customer_id": "12345678"
    }
  ],
  "connection": {
    "id": "00000000-0000-0000-0000-000000000000",
    "platform": "SHOPIFY",
    "orgId": "00000000-0000-0000-0000-000000000000"
  },
  "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="
}