Skip to content

Get a plan attachment

Request

This endpoint retrieves the details of a specific plan attachment for a subscription.

The response structure varies based on whether the plan attachment is 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
Security
ApiKeyAuth
Path
iccidstringrequired
plan_idstringrequired
GET
/v3/subscriptions/{iccid}/plan-attachments/{plan_id}
curl -i -X GET \
  'https://api.tellisim.com/v3/subscriptions/{iccid}/plan-attachments/{plan_id}?key=YOUR_API_KEY_HERE'

Responses

Successful response containing the plan attachment details (may be either recurring or non-recurring)

Bodyapplication/json
One of:
errorboolean
dataobject(PlanAttachment)
Response
{
  "error": false,
  "data": {
    "plan_attachment_id": "db83dfe3-49b7-442a-ad56-31282de2bf88",
    "created_at": "2026-06-07T11:44:33.169Z",
    "activation_at": null,
    "expiration_at": null,
    "used_allowance": { … },
    "state": "SUSPENDED",
    "plan": { … }
  }
}