Getting Started
Authentication
API Reference
- OAuth
- Plans
- Subscriptions
- Suppliers
- Prices
- Beta
Error Codes
- Introduction
- Error Types
List All Subscriptions
Returns a list of all subscriptions sorted by creation date, with most recent subscriptions first.
curl --request GET \
--url https://api.nomos.energy/subscriptions \
--header 'Authorization: Bearer <token>'{
"object": "list",
"items": [
{
"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.
Response
list Type of the object, always 'subscription'
subscription Unique identifier for the subscription
"sub_rocbrf1u5e48mm0reeqoag90"
ID of the plan
"pln_ctj3tjzc7dywznuw1dy80lb3"
ID of the customer
"cus_a8n8ol7yd4h0wohx824f0bui"
ID of the address
"adr_a7gurqkul8lzzsy1pf9p9388"
ID of the meter
"mtr_azk4zue2ijx4ff1dbjt14m5h"
ID of the payment method
"pm_adc9utqqpcp7tx054l7vg56s2"
Status of the subscription
pending, active, ended "active"
Timestamp when the subscription was created
"2024-03-14T12:00:00Z"
Timestamp when delivery was started / will start
"2024-03-14T12:00:00Z"
Timestamp when delivery was terminated
"2024-03-14T12:00:00Z"
Timestamp when the subscription was ended / will end
"2024-03-14T12:00:00Z"
ID of the previous supplier
"mp_a0x6jm5h92wde6s5dnuvha4c"
curl --request GET \
--url https://api.nomos.energy/subscriptions \
--header 'Authorization: Bearer <token>'{
"object": "list",
"items": [
{
"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"
}
]
}