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

# Objednat placenou službu

> Objedná placenou službu z katalogu (viz `/credit/services`) a odečte poplatek z vašeho kreditu. Celkový poplatek je `setup + monthly × months`, kde počet měsíců vyplývá z minimálního intervalu služby (`year` = 12, `quarter` = 3, jinak 1). U služeb se `subject: defined` musíte předmět dodat (např. text odesílatele nebo telefonní číslo); u `subject: assigned` je číslo z poolu přiděleno automaticky. Pomocí `dryrun` objednávku pouze ověříte (kredit, dostupnost) bez jakýchkoliv změn.




## OpenAPI

````yaml /openapi/rest/restapi_v1.yaml post /credit/order
openapi: 3.1.0
info:
  title: REST API SmsManager
  description: >
    REST API pro správu vašeho účtu SmsManager: API klíče, kredit, fakturace,
    kontaktní seznamy (blacklist / opt-out), zjišťování stavu zpráv, přijaté
    zprávy a podpora hromadného odesílání.


    ## Autentizace


    Pro všechny požadavky je vyžadován API klíč — zasílejte jej v HTTP hlavičce
    `x-api-key`. Svůj API klíč najdete v [nastavení
    účtu](https://app.smsmanager.com/api-cloud).


    Pro odesílání zpráv použijte [JSON API v2](https://api.smsmngr.com/v2).
  version: v1
  contact:
    url: https://smsmanager.com
    email: cc@smsmanager.com
servers:
  - url: https://rest-api.smsmngr.com/v1
    description: Produkční server
security:
  - x-api-key: []
tags:
  - name: api
    x-displayName: API klíče
    x-group: API klíče
    description: >
      Správa API klíčů: profil aktuálního klíče, vytváření a správa podřízených
      klíčů.
  - name: credit
    x-displayName: Kredit
    x-group: Kredit
    description: |
      Stav kreditu, ceník, objednatelné služby a upozornění na nízký kredit.
  - name: billing
    x-displayName: Fakturace
    x-group: Fakturace
    description: |
      Fakturační kontakt, faktury a dobití kreditu bankovním převodem.
  - name: status
    x-displayName: Stav zpráv
    x-group: Stav zpráv
    description: |
      Stav odeslaných zpráv a agregované statistiky odesílání.
  - name: inbox
    x-displayName: Přijaté zprávy
    x-group: Přijaté zprávy
    description: |
      Přijaté (příchozí) zprávy.
  - name: blacklist
    x-displayName: Blacklist a Opt-out
    x-group: Blacklist a Opt-out
    description: >
      Spravované kontaktní seznamy. Blacklist blokuje všechny zprávy na uvedená
      čísla; opt-out seznam blokuje zprávy s tagem `promotional`.
  - name: messaging
    x-displayName: Hromadné odesílání
    x-group: Hromadné odesílání
    description: >
      Podpůrné endpointy pro hromadné odesílání: URL pro nahrání hromadných
      souborů a rušení naplánovaných zpráv.
  - name: partner
    x-displayName: Partneři a integrace
    x-group: Partneři a integrace
    description: >
      Partnerský onboarding, integrace konektorů a registrace push
      zařízení/příjemců.
paths:
  /credit/order:
    post:
      tags:
        - credit
      summary: Objednat placenou službu
      description: >
        Objedná placenou službu z katalogu (viz `/credit/services`) a odečte
        poplatek z vašeho kreditu. Celkový poplatek je `setup + monthly ×
        months`, kde počet měsíců vyplývá z minimálního intervalu služby (`year`
        = 12, `quarter` = 3, jinak 1). U služeb se `subject: defined` musíte
        předmět dodat (např. text odesílatele nebo telefonní číslo); u `subject:
        assigned` je číslo z poolu přiděleno automaticky. Pomocí `dryrun`
        objednávku pouze ověříte (kredit, dostupnost) bez jakýchkoliv změn.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - service_id
                - period
              properties:
                service_id:
                  type: string
                  description: Ploché id služby z katalogu.
                  example: sender_sms_420_alnum
                period:
                  type: string
                  description: >-
                    Požadované fakturační období. Skutečné fakturační období je
                    určeno minimálním intervalem služby.
                  example: month
                subject:
                  type: string
                  description: >-
                    Předmět služby (text odesílatele, telefonní číslo, ...).
                    Povinné u služeb se `subject: defined`.
                payload:
                  type: object
                  description: Volitelná doplňková data uložená k objednávce služby.
                dryrun:
                  type: boolean
                  description: >-
                    Pokud je `true`, objednávka se pouze ověří a vrátí se
                    celkový poplatek bez jakýchkoliv změn.
            examples:
              Order text sender:
                value:
                  service_id: sender_sms_420_alnum
                  period: month
                  subject: Mojefirma
              Dry run:
                value:
                  service_id: sender_sms_420_alnum
                  period: month
                  subject: Mojefirma
                  dryrun: true
      responses:
        '200':
          description: Služba objednána
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  order:
                    type: object
                    properties:
                      subject:
                        type: string
                        description: >-
                          Předmět objednané služby (u služeb typu `assigned`
                          přidělené číslo).
                      subject_id:
                        type: string
                      status:
                        type: string
                        description: Počáteční stav služby (`new` nebo `active`).
                      dryrun:
                        type: boolean
                        description: Přítomno pouze u dry runů.
                      total_fee:
                        type: number
                        description: Celkový poplatek (pouze dry run).
                      currency:
                        type: string
                        description: Měna poplatku (pouze dry run).
                      service_id:
                        type: string
                        description: Id služby (pouze dry run).
              examples:
                Ordered:
                  value:
                    success: true
                    order:
                      subject: Mojefirma
                      subject_id: Mojefirma
                      status: new
                Dry run:
                  value:
                    success: true
                    order:
                      dryrun: true
                      total_fee: 1000
                      currency: czk
                      subject: null
                      service_id: sender_sms_420_alnum
        '400':
          description: Špatný požadavek
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                message: Missing required service fields in request data
        '500':
          description: Objednávka selhala
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Invalid service:
                  value:
                    message: Invalid service id
                Insufficient credit:
                  value:
                    message: Insufficient credit
                No available sender:
                  value:
                    message: No available sender for this service
components:
  schemas:
    Error:
      type: object
      properties:
        message:
          type: string
          description: Chybová zpráva.
  securitySchemes:
    x-api-key:
      type: apiKey
      in: header
      name: x-api-key

````