> ## Documentation Index
> Fetch the complete documentation index at: https://help.withallo.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get eSIM offer

> Returns the eSIM setup fee, the data tiers you can order and the data top-ups you can buy for an account you provisioned, priced on the subscription you pay for that account: its currency, its billing interval and your partner discount. Amounts are in the smallest currency unit (e.g. cents). Requires the `PARTNER` scope.

> [!NOTE]
>
> **Required scope:** `PARTNER`

Returns the eSIM setup fee, the data tiers and the data top-ups you can buy for one of your accounts. Call it before [Order eSIM](https://help.withallo.com/en/v2/api-reference/white-label/order-esim.md), [Change eSIM tier](https://help.withallo.com/en/v2/api-reference/white-label/change-esim-tier.md) or [Buy eSIM top-up](https://help.withallo.com/en/v2/api-reference/white-label/buy-esim-topup.md) to show or check the price.

* Prices come from the subscription you pay for that account: its currency, its billing interval and your partner discount. Two accounts on different intervals get different offers.
* Amounts are in the smallest unit of the currency (cents for EUR), before tax.
* The amounts in the example response are placeholders: the real prices are the ones this endpoint returns for the account.
* `setup_price_cents` is a one-off fee per eSIM. It is charged with the first period of the tier.
* `tiers[].price_cents` is the price of the tier per billing `interval`. Pass a `tiers[].code` as `tier` when you order or change the tier.
* `tiers[].data_mb` is the mobile data the tier includes each calendar month, in MB (1 GB = 1024 MB).
* `top_ups[]` lists the top-ups you can buy for an eSIM of this account: `TOPUP_5GB` (5120 MB), `TOPUP_10GB` (10240 MB) and `TOPUP_20GB` (20480 MB). Pass a `top_ups[].code` as `code` to [Buy eSIM top-up](https://help.withallo.com/en/v2/api-reference/white-label/buy-esim-topup.md).
* `top_ups[].price_cents` is a one-off price, in the same currency as the tiers. A top-up adds its `data_mb` to the eSIM for the current calendar month (Paris time). Unused top-up data lapses at the end of that month.
* You can only read the offer for accounts your own API key created. Any other id fails with `PARTNER_ACCOUNT_NOT_FOUND`.
* If eSIMs cannot be ordered for this account right now, the request fails with `ESIM_UNAVAILABLE`.


## OpenAPI

````yaml GET /v2/api/partner/accounts/{account_id}/esims/offer
openapi: 3.0.3
info:
  title: Allo API
  description: >-
    Allo API provides programmatic access to your Allo account, allowing you to
    manage webhooks, retrieve calls and contacts, and send SMS messages.


    All requests to `/v1/api/**` endpoints automatically go through quota
    checking and scope validation.
  version: 1.0.0
  contact:
    name: Allo Support
servers:
  - url: https://api.withallo.com
    description: Production server
security: []
tags:
  - name: Summary Templates
    description: >-
      Manage call summary templates that control how AI-generated call summaries
      are structured for your team.
  - name: Webhooks
    description: >-
      Manage webhook endpoints to receive real-time notifications about events
      in your Allo account. Each endpoint subscribes to one or more event topics
      and is verified with a signing secret.
  - name: Calls
    description: >-
      Retrieve and search call records with filtering and pagination. Filter
      calls by your Allo phone number.
  - name: Contacts
    description: >-
      Search and retrieve contact information with sorting and pagination.
      Includes engagement level tracking.
  - name: SMS
    description: Send SMS messages to phone numbers using your Allo numbers.
  - name: Fax
    description: >-
      Send a PDF as a fax from an Allo line with fax turned on. Sent and
      received faxes appear in conversation items.
  - name: Phone Numbers
    description: Retrieve information about your Allo phone numbers.
  - name: Analytics
    description: Pre-computed call metrics, team performance, and outbound dial funnel
  - name: CRM
    description: Manage people, companies, and deals in your CRM.
  - name: Notes
    description: >-
      Internal team notes on conversations and CRM people, with @mention
      support. Notes are never visible to the contact.
  - name: Threads
    description: >-
      Team discussion threads attached to a conversation item (call, SMS, or
      conversation note). One thread per item.
  - name: AI Receptionist
    description: >-
      Read and write the AI receptionist configuration of a phone line: business
      details, voice, prompt, capabilities, business hours, transfer rules,
      scheduling calendars and knowledge sources.
  - name: Inboxes
    description: >-
      Personal inboxes: saved views of one or more lines, optionally narrowed to
      phone-menu options, with their own filters and notification setting.
paths:
  /v2/api/partner/accounts/{account_id}/esims/offer:
    get:
      tags:
        - White label
      summary: Get eSIM offer
      description: >-
        Returns the eSIM setup fee, the data tiers you can order and the data
        top-ups you can buy for an account you provisioned, priced on the
        subscription you pay for that account: its currency, its billing
        interval and your partner discount. Amounts are in the smallest currency
        unit (e.g. cents). Requires the `PARTNER` scope.
      operationId: getPartnerEsimOffer
      parameters:
        - name: account_id
          in: path
          required: true
          schema:
            type: string
          description: The account id returned by Create account (`usr-*`).
      responses:
        '200':
          description: eSIM offer for the account
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      currency:
                        type: string
                        description: Currency of the subscription you pay for the account.
                        example: eur
                      interval:
                        type: string
                        enum:
                          - MONTHLY
                          - YEARLY
                        description: >-
                          Billing interval of the tiers, the same as the
                          account's subscription.
                        example: MONTHLY
                      setup_price_cents:
                        type: integer
                        format: int64
                        description: >-
                          One-off setup fee per eSIM, charged with the first
                          tier period.
                        example: 1234
                      tiers:
                        type: array
                        items:
                          type: object
                          properties:
                            code:
                              type: string
                              description: >-
                                Pass it as `tier` when you order or change the
                                tier.
                              example: ESIM_20GB
                            data_mb:
                              type: integer
                              format: int64
                              description: >-
                                Mobile data included in the tier, in MB (1 GB =
                                1024 MB).
                              example: 20480
                            price_cents:
                              type: integer
                              format: int64
                              description: Price of the tier per billing interval.
                              example: 3456
                      top_ups:
                        type: array
                        description: >-
                          Data top-ups you can buy for an eSIM of this account.
                          A top-up is charged once and adds data for the current
                          calendar month (Paris time) only.
                        items:
                          type: object
                          properties:
                            code:
                              type: string
                              enum:
                                - TOPUP_5GB
                                - TOPUP_10GB
                                - TOPUP_20GB
                              description: Pass it as `code` when you buy a top-up.
                              example: TOPUP_5GB
                            data_mb:
                              type: integer
                              format: int64
                              description: >-
                                Mobile data the top-up adds, in MB (1 GB = 1024
                                MB).
                              example: 5120
                            price_cents:
                              type: integer
                              format: int64
                              description: One-off price of the top-up, before tax.
                              example: 567
              example:
                data:
                  currency: eur
                  interval: MONTHLY
                  setup_price_cents: 1234
                  tiers:
                    - code: ESIM_5GB
                      data_mb: 5120
                      price_cents: 2345
                    - code: ESIM_20GB
                      data_mb: 20480
                      price_cents: 3456
                  top_ups:
                    - code: TOPUP_5GB
                      data_mb: 5120
                      price_cents: 567
                    - code: TOPUP_10GB
                      data_mb: 10240
                      price_cents: 890
                    - code: TOPUP_20GB
                      data_mb: 20480
                      price_cents: 1234
        '401':
          $ref: '#/components/responses/ApiUnauthorized'
        '403':
          description: The API key lacks the PARTNER scope.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
        '404':
          description: >-
            No account with this id was provisioned by your API key
            (PARTNER_ACCOUNT_NOT_FOUND).
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
        '429':
          $ref: '#/components/responses/ApiRateLimited'
        '500':
          description: >-
            eSIMs cannot be ordered for this account right now
            (ESIM_UNAVAILABLE).
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
      security:
        - ApiKeyAuth: []
components:
  responses:
    ApiUnauthorized:
      description: Invalid or missing API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    ApiRateLimited:
      description: Rate limit exceeded
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
  schemas:
    ApiError:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
            code:
              type: string
            message:
              type: string
            retryable:
              type: boolean
            request_id:
              type: string
            retry_after_seconds:
              type: integer
              nullable: true
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.