Subscriptions
Properties
id
stringRequiredThe Rutter generated unique ID of the subscription.
platform_id
stringRequiredThe platform specific ID of the subscription.
platform_customer_id
stringnullableThe platform specific ID of the customer linked to the subscription.
iso_currency_code
stringRequiredThe ISO 4217 currency code of the subscription.
status
enumRequiredStatus of subscription. Possible values are: active
, in_trial
, canceled
, paused
, unknown
items
arrayAn array of subscription items linked to the subscription.
items
attributescreated_at
stringRequiredThe ISO 8601 timestamp that the subscription was created.
updated_at
stringRequiredThe ISO 8601 timestamp that the subscription was last updated.
List Subscriptions
Request Parameters
access_token
stringqueryRequiredThe access token of the connection.
cursor
stringqueryThe cursor to use for pagination. This value is passed in from next_cursor
field in a previous request.
force_fetch
enumqueryForce a response even if the underlying connection hasn't finished the initial sync.
limit
integerqueryThe limit on the number of entities returned.
updated_at_max
integerqueryUnix Timestamp in milliseconds representing the maximum updated_at datetime to fetch entities from.
updated_at_min
integerqueryUnix Timestamp in milliseconds representing the minimum updated_at datetime to fetch entities from.
Response Body
connection
objectconnection
attributessubscriptions
arrayRequiredsubscriptions
attributesnext_cursor
stringnullableRequired- Stripe
- Chargebee
- Chargify
- Recurly
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.