Skip to content

List plan attachments

Request

This endpoint retrieves the plan attachments associated with a specific subscription identified by its ICCID.

The response structure varies based on whether the plan attachments are recurring or non-recurring:

  • For non-recurring plans: Returns basic plan attachment details with activation_at, expiration_at, used_allowance, and state
  • For recurring plans: Returns plan attachment with recurrence metadata and an array of instances, where activation_at, expiration_at, used_allowance, and state may be null at the attachment level

The response may contain a mix of both recurring and non-recurring plan attachments in the same array.

Security
ApiKeyAuth
Path
iccidstringrequired
GET
/v3/subscriptions/{iccid}/plan-attachments
curl -i -X GET \
  'https://api.tellisim.com/v3/subscriptions/{iccid}/plan-attachments?key=YOUR_API_KEY_HERE'

Responses

Successful response containing plan attachments (may include both recurring and non-recurring plans)

Bodyapplication/json
One of:
errorbooleanrequired

A boolean indicating whether there was an error in the request

Example:false
dataArray of objectsrequired

An array containing details of the plan attachments

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