Skip to main content
GET
cURL

Path Parameters

contractID
string
required
Pattern: ^[\w-]+$
userID
string
required
Pattern: ^[\w-]+$

Response

Serializer for the fully assembled consumer contract response.

saas_contract_id
string
required
meter_id
string[]
required
preferred_delivery_start
string<date>
required
previous_provider
string | null
required
subscription_reason
string
required
reg_status
enum<string>
required
  • in_revocation_period - in Widerrufsfrist
  • open_join_private - neue Quartier-Vertragsbeziehung
  • open_join - neue Vertragsbeziehung
  • pending_join - Kündigung versandt
  • open_subscribe - Wechsel akzeptiert
  • pending_subscribe - in Anmeldung
  • closed_join_incomplete - Vertrag angemeldet (Daten unvollständig)
  • closed_join - Vertrag angemeldet
  • closed_join_private - Quartier-Vertrag angemeldet
  • on_hold - Prozess angehalten
  • revoked - Vertrag widerrufen
  • awaiting_meter_installation - in Erwartung des Zählereinbaus
  • closed_leave - Vertrag abgemeldet
  • open_unsubscribe - Kündigung durch uns akzeptiert
  • pending_unsubscribe - in Abmeldung
  • unsubscribe_received - Abmeldung erhalten
  • unsubscribe_rejected - Abmeldung abgelehnt
  • open_leave - Kunde hat Vertrag gekündigt
  • pending_move - Umzug mitgeteilt
  • accounting_only - Vertrag zur Bilanzierung
  • unpaused - Vertrag wiederaufgenommen
Available options:
in_revocation_period,
open_join_private,
open_join,
pending_join,
open_subscribe,
pending_subscribe,
closed_join_incomplete,
closed_join,
closed_join_private,
on_hold,
revoked,
awaiting_meter_installation,
closed_leave,
open_unsubscribe,
pending_unsubscribe,
unsubscribe_received,
unsubscribe_rejected,
open_leave,
pending_move,
accounting_only,
unpaused
order_date
string<date>
required
market_location
string | null
required
read-only
sepa_reference
string
required
tax_number
string
required
network_provider
object
required

The compact market-partner object returned in contract detail payloads.

meter_operator
object
required

The compact market-partner object returned in contract detail payloads.

is_business
boolean
required
email
string<email>
required
Maximum string length: 254
salespartner_id
string
required
read-only
third_party_salespartner
string
required
read-only
saas_customer_id
string
required
read-only
username
string
required
delivery_end
string<date> | null
required
delivery_start
string<date> | null
required
deliv_status
string | null
required
contract_parameters
any
required
tariff_type
string[]
required
measurement_location
string[]
required
current_monthly_installment_amount
string<decimal> | null
required
Pattern: ^-?\d{0,10}(?:\.\d{0,2})?$
timeseries_category
string | null
required
deliv_address_street
string | null
Maximum string length: 70
deliv_address_house_number
string | null
Maximum string length: 35
deliv_address_zipcode
string | null
Maximum string length: 17
deliv_address_city
string | null
Maximum string length: 35
deliv_address_addition
string | null
Maximum string length: 50
annual_consumption
number<double> | null
status_info
string | null
contract_termination_date
string<date> | null
bank_data_first_name
string | null
Maximum string length: 128
bank_data_last_name
string | null
Maximum string length: 128
bank_data_iban
string
Maximum string length: 34
bank_data_bic
string | null
Maximum string length: 11
payment_method
enum<string>
  • credit_card_display_only - Kreditkarte (nur Anzeige)
  • direct_debit - SEPA Einzugsermächtigung
  • bank_transfer - Überweisung
  • credit_card - Kreditkarte
  • no_payment_method - Keine Zahlmethode
Available options:
credit_card_display_only,
direct_debit,
bank_transfer,
credit_card,
no_payment_method
sepa_date
string<date> | null
bill_address_street
string | null
Maximum string length: 70
bill_address_house_number
string | null
Maximum string length: 35
bill_address_zipcode
string | null
Maximum string length: 17
bill_address_city
string | null
Maximum string length: 35
bill_address_addition
string | null
Maximum string length: 50
custom_name
string | null
Maximum string length: 100
redispatch_included
boolean | null
first_name
string | null
Maximum string length: 255
last_name
string | null
Maximum string length: 255
company_name
string
Maximum string length: 256
telephone
string
Maximum string length: 32
accounting_email
string<email> | null
Maximum string length: 254
is_small_business
boolean
salutation
  • Frau - Frau
  • Herr - Herr
  • Eheleute - Eheleute
  • Divers - Divers
Available options:
Frau,
Herr,
Eheleute,
Divers
name_title
  • `` - Titel
  • Dr. - Dr.
  • Prof. - Prof.
  • Prof. Dr. - Prof. Dr.
Available options:
Dr.,
Prof.,
Prof. Dr.
masked_credit_card
string

Make sure that no more than 4 trailing digits are included! The rest of the space may be used for decorative purpose.

Maximum string length: 16
credit_card_validity_date
string<date> | null

Commonly notated as MM/YY on a payment card; Please find the last day of that month.

bill_address_post_box
string
Maximum string length: 64
contract_termination_reason
  • E01 - Einzug-/Auszug (Umzug) (E01)
  • E03 - Wechsel (E03)
  • ZT4 - Ende wegen Kündigung durch LF (ZT4)
  • ZT5 - Ende wegen Kündigung durch Kunde/LFN (ZT5)
  • Z33 - Auszug/Stilllegung (Z33)
  • Z41 - Ende der ESV ohne Folgelieferung (Z41)
  • ZG9 - Aufhebung einer zukünftigen Zuordnung wegen Auszug des Kunden (ZG9)
  • ZH1 - Aufhebung einer zukünftigen Zuordnung wegen Stilllegung (ZH1)
  • ZH2 - Aufhebung einer zukünftigen Zuordnung wegen aufgehobenem Vertragsverhältnis (ZH2)
Available options:
E01,
E03,
ZT4,
ZT5,
Z33,
Z41,
ZG9,
ZH1,
ZH2
is_consumer
boolean