# Subscriptions

Operations related to subscriptions.

## List Subscriptions

 - [GET /v3/subscription](https://api-docs.tellisim.com/openapi/subscriptions/kuy01agj9wxkq-list-subscriptions.md): 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, and SIM details.

## Create Subscriptions

 - [POST /v3/subscription](https://api-docs.tellisim.com/openapi/subscriptions/y0553xy7w914c-create-subscriptions.md): This endpoint allows users to create a new subscription for a SIM. By sending a POST request to the specified URL, users can initiate the subscription process with the necessary parameters.
The optional active_period field controls when the subscription becomes active and (optionally) when it expires.

## Get a subscription

 - [GET /v3/subscriptions/{iccid}](https://api-docs.tellisim.com/openapi/subscriptions/9r03ycqqjdxez-get-a-subscription.md): This endpoint retrieves the details of a specific subscription associated with an eSIM, identified by its ICCID. It provides information such as the subscription ID, creation date, metadata, and SIM or Physical SIM details.

## Delete a Subscription

 - [DELETE /v3/subscriptions/{iccid}](https://api-docs.tellisim.com/openapi/subscriptions/r5cdqtky0qde0-delete-a-subscription.md): Deletes the subscription and recycles the ICCID associated with it. The associated ICCID goes back into the customer inventory and will be picked up again automatically in the creation of a new subscription at some point in time in future.

 Note: this operation will fail if the esim profile associated with the ICCID was ever downloaded by an end-user.

## List plan attachments

 - [GET /v3/subscriptions/{iccid}/plan-attachments](https://api-docs.tellisim.com/openapi/subscriptions/urh0yrd5tx486-list-plan-attachments.md): This endpoint retrieves the plan attachments associated with a specific subscription identified by its ICCID.

## Get a plan attachment

 - [GET /v3/subscriptions/{iccid}/plan-attachments/{plan_id}](https://api-docs.tellisim.com/openapi/subscriptions/get-plan-attachment-by-id.md): This endpoint retrieves the details of a specific plan attachment for a subscription.

## Suspend a plan attachment

 - [POST /v3/subscriptions/{iccid}/plan-attachments/{id}/suspend](https://api-docs.tellisim.com/openapi/subscriptions/7vircgwk1k8dm-suspend-a-plan-attachment.md): This operation stops all telco services on this attachment and puts it in a suspended state. This is a non-reversible operation.

## Send sms

 - [POST /v3/subscriptions/{iccid}/send-sms](https://api-docs.tellisim.com/openapi/subscriptions/8znze4vr6c4v9-send-sms.md): This endpoint allows you to send an SMS message to a specified eSIM subscription identified by its ICCID. The request requires an API key for authentication and includes parameters for the sender's name and the message content.