Subscriptions

Retrieve subscriptions, query subscriptions by Salesforce identity, view subscription timelines, and create custom timeline events.

Get subscriptions by Salesforce ID

get

This API can be used to see all of the subscriptions that are attached to a specified Salesforce ID.

Required scopes

This endpoint requires the following scopes:

Authorizations

AuthorizationstringRequired

OAuth 2.0 Bearer token for authenticated API access. Required for order submission, object management, and administrative operations.

Obtain a token via the OAuth flow described in OAuth Bearer Token.

Pass the token in the Authorization header: Bearer <token>

Path parameters

idstringRequired

The Salesforce Identity

Query parameters

queryMorestringOptional

A hash returned from a call to the API that can be used to retrieve the next page of results.

Responses

200

application/json

queryMorestringOptional

Cursor for the next page of results

Example:

DnF1ZXJ5VGhlbkZldGNoBQAAAAAAGH_TFnZndVVMaWN4VFZDbnVIbGpRRDFaaUEAAAAAABh_1BZ2Z3VVTGljeFRWQ251 SGxqUUQxWmlBAAAAAAAYf9YWdmd1VUxpY3hUVkNudUhsalFEMVppQQAAAAAAGH_XFnZndVVMaWN4VFZDbnVIbGpRRDFa aUEAAAAAABh_1RZ2Z3VVTGljeFRWQ251SGxqUUQxWmlB

401

Unauthorized — the request lacks valid authentication credentials. Verify your Bearer token or API key is correct and has not expired.

application/json

502

Bad Gateway — an upstream service returned an unexpected response. This typically indicates an issue with the request payload (e.g. invalid field values, missing required fields) or a transient infrastructure error. Retry the request, and if the issue persists, verify the request body matches the expected schema.

application/json

get

/objects/salesforce/identities/{id}/subscriptions

GET /api/objects/salesforce/identities/{id}/subscriptions HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "subscriptions": [
    {
      "name": "2TJ25TK632EG",
      "start": "2024-02-12",
      "data": {
        "name": "Digital Monthly UK multiple",
        "tracking": {
          "offers": [
            "/offers2/Digital Monthly UK multiple"
          ],
          "purchaseCountryCode": "GB",
          "accountId": "0018c000031m4fHAAQ",
          "contactId": "0038c00003WEiIPAA1",
          "userId": "0058c00000ADNGKAA5"
        },
        "offer": {
          "mode": "production",
          "path": "/offers2/Digital Monthly UK multiple",
          "data": {
            "price__limio": [],
            "created": "2024-02-28T15:22:14+00:00",
            "duplicatedFrom": "/offers2/$75 for 52 weeks then $31.96 every 4 weeks autorenew",
            "type": "item",
            "version": "64e79ce3cbe2474c5b5fcbc5af229ec0d2439b12",
            "record_type": "offer",
            "productBundles": [
              {
                "revenue_split": "100",
                "product_path": "/products/Digital",
                "rate_plan": "$75 dollar per week"
              }
            ],
            "products": [
              {
                "baseTemplate": "/config/templates/products/default",
                "entitlements": [
                  {
                    "$ref": "/entitlements/Digital"
                  }
                ],
                "path": "/products/Digital",
                "created": "2023-12-11T13:44:43+00:00",
                "modified": "2024-01-15T13:56:18+00:00",
                "attributes": {
                  "display_name__limio": "Digital",
                  "has_delivery__limio": false,
                  "product_code__limio": "LI.DIGITAL"
                },
                "record_type": "product",
                "lastSynced": "2024-03-12T16:00:35.232Z",
                "synced": true,
                "syncedFrom": "2c92c0f9778c090d0177aa4f357d043b"
              }
            ],
            "baseTemplate": "/config/templates/offers/default",
            "path": "/offers2/$75 for 52 weeks then $31.96 every 4 weeks autorenew",
            "priceReference": "/offers2/$75 for 52 weeks then $31.96 every 4 weeks autorenew",
            "price": [],
            "name": "$75 for 52 weeks then $31.96 every 4 weeks autorenew",
            "modified": "2024-03-08T10:53:37+00:00",
            "attributes": {
              "checkout_description__limio": "<p>Description</p>",
              "price__limio": [
                {
                  "delay_interval_type": "weeks",
                  "name": "charge_1",
                  "delay_interval": "2",
                  "repeat_interval": 52,
                  "attributes": [],
                  "label": "Charge 1",
                  "trigger": "order_date",
                  "repeat_interval_type": "weeks",
                  "repeat_count": 1,
                  "type": "recurring",
                  "value": "75.00",
                  "currencyCode": "USD"
                }
              ],
              "default_quantity_options__limio": null,
              "supportBillingFrequencyChange__zuora": true,
              "allowed_countries__limio": [
                "AX"
              ],
              "label__limio": [
                "default"
              ],
              "term__limio": {
                "renewal_type": "EVERGREEN",
                "renewal_trigger": "EXTERNAL"
              },
              "display_price__limio": "<p>Display Price</p>",
              "cta_text__limio": "buy",
              "payment_types__limio": [
                "zuora_card"
              ],
              "sales_channel__limio": [
                "Online"
              ],
              "display_name__limio": "$75 for 52 weeks then $31.96 every 4 weeks autorenew 1",
              "checkout__limio": {
                "checkout_type": "standard"
              },
              "initial_term__limio": {
                "renewal_type": "TERMED",
                "length": 52,
                "renewal_trigger": "EXTERNAL",
                "type": "weeks"
              },
              "push_to_checkout__limio": true,
              "autoRenew__limio": true,
              "offer_type__limio": "standard"
            },
            "id": "998f6ca141d60006e1e239b9f4b4e725bf1615d3",
            "user": "[email protected]"
          },
          "service": "limio",
          "created": "2024-01-24T10:18:17.578Z",
          "name": "Digital Monthly UK multiple",
          "id": "95dc800a5c77fd461744c9e0c638ac58c778eeaf",
          "type": "item",
          "updated": "2024-01-24T10:18:17.578Z",
          "version": "8f72261aebfba7069338ae0845ef31a15460b88e",
          "record_type": "offer",
          "status": "active"
        },
        "quantity": 1,
        "termEndDate": "2024-03-12",
        "price": {
          "summary": {
            "headline": "<p>£5.99</p>"
          },
          "currency": "GBP",
          "amount": 5.99
        },
        "termStartDate": "2024-02-12",
        "attributes": {
          "gift": false,
          "external": false
        },
        "id": "bc371cb3-43a9-1c83-722a-b56eeb212dbb",
        "purchaseCountry": "GB",
        "startDate": "2024-02-12",
        "products": [
          {
            "baseTemplate": "/config/templates/products/default",
            "entitlements": [
              {
                "$ref": "/entitlements/Digital"
              }
            ],
            "path": "/products/Digital",
            "created": "2023-12-11T13:44:43+00:00",
            "modified": "2024-01-15T13:56:18+00:00",
            "attributes": {
              "display_name__limio": "Digital",
              "has_delivery__limio": false,
              "product_code__limio": "LI.DIGITAL"
            },
            "record_type": "product",
            "lastSynced": "2024-03-12T16:00:35.232Z",
            "synced": true,
            "syncedFrom": "2c92c0f9778c090d0177aa4f357d043b"
          }
        ],
        "schedule": [
          {
            "data": {
              "date": "2026-03-13T12:37:18.742Z",
              "amountWithoutTax": "text",
              "lineItems": [
                {
                  "amountWithoutTax": "text",
                  "processingType": "text",
                  "quantity": 1,
                  "taxAmount": "text",
                  "chargeName": "text",
                  "productName": "text",
                  "chargeDescription": "text"
                }
              ]
            }
          }
        ],
        "offers": [
          {
            "mode": "production",
            "path": "/offers2/Digital Monthly UK multiple",
            "data": {
              "price__limio": [],
              "created": "2024-02-28T15:22:14+00:00",
              "duplicatedFrom": "/offers2/$75 for 52 weeks then $31.96 every 4 weeks autorenew",
              "type": "item",
              "version": "64e79ce3cbe2474c5b5fcbc5af229ec0d2439b12",
              "record_type": "offer",
              "productBundles": [
                {
                  "revenue_split": "100",
                  "product_path": "/products/Digital",
                  "rate_plan": "$75 dollar per week"
                }
              ],
              "products": [
                {
                  "baseTemplate": "/config/templates/products/default",
                  "entitlements": [
                    {
                      "$ref": "/entitlements/Digital"
                    }
                  ],
                  "path": "/products/Digital",
                  "created": "2023-12-11T13:44:43+00:00",
                  "modified": "2024-01-15T13:56:18+00:00",
                  "attributes": {
                    "display_name__limio": "Digital",
                    "has_delivery__limio": false,
                    "product_code__limio": "LI.DIGITAL"
                  },
                  "record_type": "product",
                  "lastSynced": "2024-03-12T16:00:35.232Z",
                  "synced": true,
                  "syncedFrom": "2c92c0f9778c090d0177aa4f357d043b"
                }
              ],
              "baseTemplate": "/config/templates/offers/default",
              "path": "/offers2/$75 for 52 weeks then $31.96 every 4 weeks autorenew",
              "priceReference": "/offers2/$75 for 52 weeks then $31.96 every 4 weeks autorenew",
              "price": [],
              "name": "$75 for 52 weeks then $31.96 every 4 weeks autorenew",
              "modified": "2024-03-08T10:53:37+00:00",
              "attributes": {
                "checkout_description__limio": "<p>Description</p>",
                "price__limio": [
                  {
                    "delay_interval_type": "weeks",
                    "name": "charge_1",
                    "delay_interval": "2",
                    "repeat_interval": 52,
                    "attributes": [],
                    "label": "Charge 1",
                    "trigger": "order_date",
                    "repeat_interval_type": "weeks",
                    "repeat_count": 1,
                    "type": "recurring",
                    "value": "75.00",
                    "currencyCode": "USD"
                  }
                ],
                "default_quantity_options__limio": null,
                "supportBillingFrequencyChange__zuora": true,
                "allowed_countries__limio": [
                  "AX"
                ],
                "label__limio": [
                  "default"
                ],
                "term__limio": {
                  "renewal_type": "EVERGREEN",
                  "renewal_trigger": "EXTERNAL"
                },
                "display_price__limio": "<p>Display Price</p>",
                "cta_text__limio": "buy",
                "payment_types__limio": [
                  "zuora_card"
                ],
                "sales_channel__limio": [
                  "Online"
                ],
                "display_name__limio": "$75 for 52 weeks then $31.96 every 4 weeks autorenew 1",
                "checkout__limio": {
                  "checkout_type": "standard"
                },
                "initial_term__limio": {
                  "renewal_type": "TERMED",
                  "length": 52,
                  "renewal_trigger": "EXTERNAL",
                  "type": "weeks"
                },
                "push_to_checkout__limio": true,
                "autoRenew__limio": true,
                "offer_type__limio": "standard"
              },
              "id": "998f6ca141d60006e1e239b9f4b4e725bf1615d3",
              "user": "[email protected]"
            },
            "service": "limio",
            "created": "2024-01-24T10:18:17.578Z",
            "name": "Digital Monthly UK multiple",
            "id": "95dc800a5c77fd461744c9e0c638ac58c778eeaf",
            "type": "item",
            "updated": "2024-01-24T10:18:17.578Z",
            "version": "8f72261aebfba7069338ae0845ef31a15460b88e",
            "record_type": "offer",
            "status": "active"
          }
        ],
        "address": []
      },
      "status": "active",
      "record_type": "subscription",
      "owner": "id-62401f8d5bf6b26a37ea0defd66fd005",
      "customer": "cus-3578da83e3e4f12dff39b314bb486ca6",
      "id": "sub-02ecc45ed0c313a8dc4dd84c45854796",
      "service": "limio",
      "ref": "order-4dd195c3eee4297e33aecb5436cf8092/bc371cb3-43a9-1c83-722a-b56eeb212dbb",
      "created": "2024-02-12T17:27:50.087Z",
      "updated": "2024-02-12T17:27:54.005Z",
      "reference": "2TJ25TK632EG",
      "mode": "production"
    }
  ],
  "customers": [
    {
      "data": {
        "name": "Jane Smith",
        "email": "[email protected]",
        "firstName": "Jane",
        "lastName": "Smith",
        "purchaseCountry": "GB",
        "trialist": false,
        "address": [
          {
            "record_type": "address",
            "id": "address-sadsdasdaasd",
            "relationship_id": "rel-4d84ed598c025e72561dedfe029e5ec0",
            "data": {
              "firstName": "First",
              "lastName": "Last",
              "country": "United Kingdom",
              "address2": "Address 2",
              "city": "City",
              "address1": "Address 1",
              "postalCode": "SW1A 1AA",
              "company": "string",
              "state": "State",
              "email": "[email protected]"
            },
            "related": "cus-238a6ee4b713ea8547b44ad1321d9a1d",
            "service": "limio",
            "start": "2026-03-13T12:37:18.742Z",
            "relationship_type": "billing",
            "mode": "production",
            "created": "2024-02-13T14:20:24.658Z",
            "status": "active",
            "owner": "id-3c0f1c952150f672a50224da2d7fd561",
            "customer": "cus-238a6ee4b713ea8547b44ad1321d9a1d",
            "updated": "2024-02-13T14:20:24.658Z",
            "reference": "6CR7JI0LQBB0"
          }
        ]
      },
      "status": "active",
      "record_type": "customer",
      "owner": "id-62401f8d5bf6b26a37ea0defd66fd005",
      "id": "cus-3578da83e3e4f12dff39b314bb486ca6",
      "service": "limio",
      "created": "2024-02-12T17:27:50.087Z",
      "updated": "2024-02-12T17:27:54.005Z",
      "reference": "CUST-REF-001",
      "mode": "production"
    }
  ],
  "queryMore": "DnF1ZXJ5VGhlbkZldGNoBQAAAAAAGH_TFnZndVVMaWN4VFZDbnVIbGpRRDFaaUEAAAAAABh_1BZ2Z3VVTGljeFRWQ251 SGxqUUQxWmlBAAAAAAAYf9YWdmd1VUxpY3hUVkNudUhsalFEMVppQQAAAAAAGH_XFnZndVVMaWN4VFZDbnVIbGpRRDFa aUEAAAAAABh_1RZ2Z3VVTGljeFRWQ251SGxqUUQxWmlB"
}

Add a Timeline Event

post

Currently supported for subscriptions. To create a custom Event and attach it to that specified Object’s Timeline.

Authorizations

AuthorizationstringRequired

OAuth 2.0 Bearer token for authenticated API access. Required for order submission, object management, and administrative operations.

Obtain a token via the OAuth flow described in OAuth Bearer Token.

Pass the token in the Authorization header: Bearer <token>

Body

forSubscriptionone ofRequired

Subscription to add the event for

namestringRequired

Event name

Example: Order Received

typestringRequired

Domain/type of event

Example: order.event_received

sourcestringOptional

Source of the event e.g. system, user, webhook

Example: webhook

Responses

200

application/json

idstringRequired

Limio event ID generated for the created event

Example: event-03bc891227308ae7c7a258240ac60b82

referencestringRequired

Limio event reference generated for the created event

Example: 3NI4H49PGHBG

statusstringRequired

Processing status of the event

Example: submitted

400

Bad request (missing or invalid fields)

401

Unauthorized — the request lacks valid authentication credentials. Verify your Bearer token or API key is correct and has not expired.

application/json

404

Not found

502

application/json

post

/timeline/subscription

POST /api/timeline/subscription HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 200

{
  "forSubscription": {
    "name": "text"
  },
  "name": "Order Received",
  "type": "order.event_received",
  "source": "webhook",
  "fields": [
    {
      "label": "Offer Name",
      "type": "string",
      "value": "My offer",
      "additionalInfo": "GBP"
    }
  ]
}

{
  "id": "event-03bc891227308ae7c7a258240ac60b82",
  "reference": "3NI4H49PGHBG",
  "status": "submitted"
}

Get Subscription Timeline

get

Retrieves timeline data for a given subscription or customer by ID. This API aggregates relevant events, payment methods, addresses, offers, and schedules to create a chronological activity history.

For subscriptions path parameter: Returns timeline for that specific subscription
For customers path parameter: Returns timeline for all subscriptions owned by that customer

Authorizations

AuthorizationstringRequired

OAuth 2.0 Bearer token for authenticated API access. Required for order submission, object management, and administrative operations.

Obtain a token via the OAuth flow described in OAuth Bearer Token.

Pass the token in the Authorization header: Bearer <token>

Path parameters

path_typestring · enum · max: 20Required

The type of entity to retrieve timeline for

Example: subscriptionsPossible values:

idstring · max: 60Required

The unique identifier of the subscription or customer

Example: sub-fdb5ff44f3513733c91869c43fdd37ba0

Responses

200

Successfully retrieved timeline data

application/json

400

Bad request - Invalid parameters

application/json

401

Unauthorized — the request lacks valid authentication credentials. Verify your Bearer token or API key is correct and has not expired.

application/json

404

Subscription or customer not found

application/json

502

application/json

get

/timeline/{path_type}/{id}

GET /api/timeline/{path_type}/{id} HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "metadata": {
    "ownerId": "id-dff9df30bdaa4d7f8b19681af37db6c7"
  },
  "subscriptions": [
    {
      "action": "New Subscription",
      "type": "order.new",
      "subscriptionId": "sub-fdb5ff44f3513733c91869c43fdd37ba0",
      "subscriptionNumber": "32F5P8T7EG40",
      "created": "2024-01-15T10:30:00Z",
      "createdBy": "0058c00000ADNGKAA5",
      "status": "completed",
      "service": "Zuora",
      "fields": [
        {
          "label": "Offer Name",
          "value": "Premium Monthly",
          "type": "string"
        },
        {
          "label": "Price",
          "value": "$29.99",
          "type": "currency"
        }
      ]
    },
    {
      "action": "Change Payment",
      "type": "order.change_payment",
      "subscriptionId": "sub-fdb5ff44f3513733c91869c43fdd37ba0",
      "subscriptionNumber": "32F5P8T7EG40",
      "created": "2024-01-20T14:15:00Z",
      "createdBy": "0058c00000ADNGKAA5",
      "status": "completed",
      "service": "Zuora",
      "fields": [
        {
          "label": "Payment Method",
          "value": "****1234",
          "type": "string"
        }
      ]
    }
  ]
}

PreviousObjects NextIdentities

Last updated 10 days ago

Was this helpful?

hashtagGet subscriptions by Salesforce ID

hashtagAdd a Timeline Event

hashtagGet Subscription Timeline

Get subscriptions by Salesforce ID

Add a Timeline Event

Get Subscription Timeline