Subscriptions
Create a subscription
Getting Started
Authentication
API Reference
- OAuth
- Plans
- Subscriptions
- Suppliers
- Prices
- Beta
Error Codes
- Introduction
- Error Types
Subscriptions
Create a subscription
Create a new subscription
POST
/
subscriptions
curl --request POST \
--url https://api.nomos.energy/subscriptions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"plan": "pln_zfyg8cvlhkniou9546m1r2th",
"customer": {
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@example.com"
},
"address": {
"street": "Torstraße",
"house_number": "119",
"zip": "10115",
"city": "Berlin"
},
"meter": {
"number": "1APA0195124010",
"type": "smart",
"estimated_usage": 2500
},
"payment_method": {
"type": "sepa_debit",
"sepa_debit": {
"iban": "DE68500105178297336485",
"account_holder": "John Doe"
}
},
"previous_supplier": "mp_zcswt7maydm5ai8rhgh65qr5",
"next_possible_start": true,
"intended_start_date": "2024-01-01",
"lead": "lead_y281j3ujf6xlpepsqe3zdtib"
}'
{
"object": "subscription",
"id": "sub_rocbrf1u5e48mm0reeqoag90",
"plan": "pln_ctj3tjzc7dywznuw1dy80lb3",
"customer": "cus_a8n8ol7yd4h0wohx824f0bui",
"address": "adr_a7gurqkul8lzzsy1pf9p9388",
"meter": "mtr_azk4zue2ijx4ff1dbjt14m5h",
"payment_method": "pm_adc9utqqpcp7tx054l7vg56s2",
"supplier": "mp_a0x6jm5h92wde6s5dnuvha4c",
"status": "active",
"created_at": "2024-03-14T12:00:00Z",
"start_at": "2024-03-14T12:00:00Z",
"terminated_at": "2024-03-14T12:00:00Z",
"end_at": "2024-03-14T12:00:00Z"
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
The subscription to create
The body is of type object
.
Response
200
application/json
The created subscription details
The response is of type object
.
curl --request POST \
--url https://api.nomos.energy/subscriptions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"plan": "pln_zfyg8cvlhkniou9546m1r2th",
"customer": {
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@example.com"
},
"address": {
"street": "Torstraße",
"house_number": "119",
"zip": "10115",
"city": "Berlin"
},
"meter": {
"number": "1APA0195124010",
"type": "smart",
"estimated_usage": 2500
},
"payment_method": {
"type": "sepa_debit",
"sepa_debit": {
"iban": "DE68500105178297336485",
"account_holder": "John Doe"
}
},
"previous_supplier": "mp_zcswt7maydm5ai8rhgh65qr5",
"next_possible_start": true,
"intended_start_date": "2024-01-01",
"lead": "lead_y281j3ujf6xlpepsqe3zdtib"
}'
{
"object": "subscription",
"id": "sub_rocbrf1u5e48mm0reeqoag90",
"plan": "pln_ctj3tjzc7dywznuw1dy80lb3",
"customer": "cus_a8n8ol7yd4h0wohx824f0bui",
"address": "adr_a7gurqkul8lzzsy1pf9p9388",
"meter": "mtr_azk4zue2ijx4ff1dbjt14m5h",
"payment_method": "pm_adc9utqqpcp7tx054l7vg56s2",
"supplier": "mp_a0x6jm5h92wde6s5dnuvha4c",
"status": "active",
"created_at": "2024-03-14T12:00:00Z",
"start_at": "2024-03-14T12:00:00Z",
"terminated_at": "2024-03-14T12:00:00Z",
"end_at": "2024-03-14T12:00:00Z"
}