Skip to content

List Subscriptions

Request

This endpoint allows users to retrieve subscription details associated with the SIM service. It provides information about the subscription, including its ID, creation date, associated metadata, customer email, tags, and SIM details. Results can be filtered by an exact customer email match and by tags. When multiple tag pairs are provided, a subscription must contain all of them; it may contain additional tags.

Security
ApiKeyAuth
Query
customer_emailstring, (email)

Filter subscriptions by an exact customer email match.

Example:customer_email=customer@example.com
tagsobject

Filter subscriptions by tag pairs using bracket notation, for example tags[order_ref]=SHOP-98213&tags[source]=web_checkout. The subscription's tags must contain every supplied key-value pair (AND semantics), but may contain additional pairs.

Example:order_ref=SHOP-98213&source=web_checkout
GET
/v3/subscription
curl -i -X GET \
  'https://api.tellisim.com/v3/subscription?customer_email=customer%40example.com&tags=%7B%22order_ref%22%3A%22SHOP-98213%22%2C%22source%22%3A%22web_checkout%22%7D&key=YOUR_API_KEY_HERE'

Responses

Successful response containing subscription details

Bodyapplication/json
errorbooleanrequired

Indicates whether there was an error in the request

Example:false
dataArray of objectsrequired

Contains an array of subscription objects

Response
{
  "error": false,
  "data": [
    { … }
  ]
}