> For the complete documentation index, see [llms.txt](https://bump.sh/zim/doc/esim-api/llms.txt)

# List Plans compatible for a top-up

> GET /subscriptions/{subscriptionID}/compatible-plans
> 
> Returns the Plans that can be used to top up this Subscription (same network provider and same coverage). Pass one of them as `planID` with `type: TOP_UP` to `POST /v2/orders`.



## Servers
- Production: https://zim.api.zimconnections.com (Production)
- Sandbox: https://zim.api.dev.zimconnections.com (Sandbox)


## Authentication methods
- Oauth2 & App identifier


## Parameters

### Path parameters

- **subscriptionID** (string)
  ID of the Subscription




## Responses
### 200
Compatible Plans

#### Body: application/json (array[object])
- **id** (string)

- **name** (string)

- **scope** (string)
  * `LOCAL` - single Destination * `REGIONAL` - a Region (several Destinations) * `GLOBAL` - worldwide coverage

- **category** (string)

- **type** (string)
  * `DATA` - Data-only Plans * `VOICE_AND_DATA` - Plans including voice (and SMS) in addition to data

- **isRecurring** (boolean)
  `true` for recurring plans such as UK domestic plans

- **recurringInterval** (string | null)
  Billing interval of recurring plans (`MONTHLY` for UK domestic plans), `null` for one-off plans

- **destination** (object)

- **region** (object)

- **dataUnit** (string)
  Possible values:
    * `MB` - MegaByte representation
    * `GB` - GigaByte representation

- **dataValue** (number)
  Details:
    * If `dataValue` >= 0 then the plan is capped to that amount of consumable data
    * If `dataValue` == -1 then the plan is unlimited and does not have a cap on consumable data

- **callUnit** (string)
  Details:
    * `MINUTES` - Minutes representation
    * `HOURS` - Hours representation

- **callValue** (number)
  Details:
    * If `callValue` >= 0 then the plan is capped to that amount of consumable call time
    * If `callValue` == -1 then the plan is unlimited and does not have a cap on call time

- **smsUnit** (string)

- **smsValue** (number)
  Details:
    * If `smsValue` >= 0 then the plan is capped to that amount of consumable SMS sent
    * If `smsValue` == -1 then the plan is unlimited and does not have a cap on SMS sent

- **durationUnit** (string)

- **durationValue** (number)

- **features** (array[object])

- **prices** (array[object])

- **createdAt** (string(date-time))


### 401
Missing or invalid access token or `X-App-Identifier`

#### Body: application/json (object)
- **statusCode** (integer)

- **message** (string | array[string])
  Human-readable reason, or one entry per invalid property for validation errors

- **error** (string)


### 404
Resource not found or not owned by your Account

#### Body: application/json (object)
- **statusCode** (integer)

- **message** (string | array[string])
  Human-readable reason, or one entry per invalid property for validation errors

- **error** (string)



[Powered by Bump.sh](https://bump.sh)
