logo

Subscription

APIs related to Limio Subscriptions

Get subscriptions by Salesforce ID

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

SecuritybearerAuth
Request
path Parameters
id
required
string

The Salesforce Identity

query Parameters
queryMore
string

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

Responses
200

OK

401

Unauthorized

502

Bad Gateway

get/objects/salesforce/identities/{id}/subscriptions
Request samples 
Response samples 
application/json
{
  • "subscriptions": [
    ],
  • "customers": [
    ],
  • "queryMore": "DnF1ZXJ5VGhlbkZldGNoBQAAAAAAGH_TFnZndVVMaWN4VFZDbnVIbGpRRDFaaUEAAAAAABh_1BZ2Z3VVTGljeFRWQ251 SGxqUUQxWmlBAAAAAAAYf9YWdmd1VUxpY3hUVkNudUhsalFEMVppQQAAAAAAGH_XFnZndVVMaWN4VFZDbnVIbGpRRDFa aUEAAAAAABh_1RZ2Z3VVTGljeFRWQ251SGxqUUQxWmlB"
}
Add a Timeline Event
Currently supported for subscriptions. To create a custom Event and attach it to that specified Object’s Timeline.


SecuritybearerAuth 
Request 
Request Body schema: application/json
required
required
SubscriptionByName (object) or SubscriptionById (object)
Subscription to add the event for


 
One of:
Update subscription by name


name
string
 
name
required
string
Event name


 
type
required
string
Domain/type of event


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


 
required
Array of objects (TimelineField) 
Renderable data for the Timeline. Each item is shown as a field row in the UI. Use additionalInfo for currency codes, date locale hints, masks, etc.


 
 Array 
label
required
string
Field label to display in the Timeline UI


 
type
required
string
Type of field to render


 Enum: "string" "date" "currency" "number" "boolean" "json"  
string or number or boolean or null
Field value as rendered by the Timeline. Null values hide the row.


 
additionalInfo
string
Optional metadata for formatting (e.g. currency code GBP, locale GB)


 
Responses 
200
OK


400
Bad request (missing or invalid fields)


401
Unauthorized


404
Not found


502
Bad Gateway


post/timeline/subscription
Request samples 
application/json
{
  • "forSubscription": {
    },
  • "name": "Order Received",
  • "type": "order.event_received",
  • "source": "webhook",
  • "fields": [
    ]
}
Response samples 
application/json
{
  • "id": "event-03bc891227308ae7c7a258240ac60b82",
  • "reference": "3NI4H49PGHBG",
  • "status": "submitted"
}
Get Subscription Timeline
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
    • 



SecuritybearerAuth 
Request 
path Parameters
path_type
required
string  <= 20 characters 
The type of entity to retrieve timeline for


 Enum: "subscriptions" "customers"  
 Example:  subscriptions
id
required
string  <= 60 characters 
The unique identifier of the subscription or customer


 
 Example:  sub-fdb5ff44f3513733c91869c43fdd37ba0
Responses 
200
Successfully retrieved timeline data


400
Bad request - Invalid parameters


401
Unauthorized


404
Subscription or customer not found


502
Bad Gateway


get/timeline/{path_type}/{id}
Request samples 
Response samples 
application/json
{
  • "metadata": {
    },
  • "subscriptions": [
    ]
}
➔ Next to Identities