Getting Started
Authentication
API Reference
- Plans
- Previous Suppliers
- Quotes
- Subscriptions
- Prices
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_a05fl82x36f6endetxm8rrra",
"number": "28510261",
"plan": "pln_d9rfz7502xdyklkp9946ttci",
"customer": "cus_e2dl2weoltplx906rq9ur7or",
"address": "adr_bhsnhlfe3wds3r9ku5tkrdsw",
"meter": "mtr_d9rfz7502xdyklkp9946ttci",
"payment_method": "pm_d9rfz7502xdyklkp9946ttci",
"status": "pending",
"created_at": "2024-01-01T00:00:00Z",
"start_at": null,
"terminated_at": null,
"end_at": null
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Response
Type of object is always list.
"list"
Type of object is always subscription.
"subscription"
Unique identifier for the subscription.
"sub_a05fl82x36f6endetxm8rrra"
Unique number for the subscription.
"28510261"
ID of the plan associated with this subscription.
"pln_d9rfz7502xdyklkp9946ttci"
ID of the customer associated with this subscription.
"cus_e2dl2weoltplx906rq9ur7or"
ID of the delivery address.
"adr_bhsnhlfe3wds3r9ku5tkrdsw"
ID of the meter associated with this subscription.
"mtr_d9rfz7502xdyklkp9946ttci"
ID of the payment method associated with this subscription.
"pm_d9rfz7502xdyklkp9946ttci"
Status of the subscription.
pending, active, ended "pending"
When the subscription was created.
"2024-01-01T00:00:00Z"
When the subscription became active.
null
When the subscription was terminated.
null
When the subscription ended.
null
curl --request GET \
--url https://api.nomos.energy/subscriptions \
--header 'Authorization: Bearer <token>'{
"object": "list",
"items": [
{
"object": "subscription",
"id": "sub_a05fl82x36f6endetxm8rrra",
"number": "28510261",
"plan": "pln_d9rfz7502xdyklkp9946ttci",
"customer": "cus_e2dl2weoltplx906rq9ur7or",
"address": "adr_bhsnhlfe3wds3r9ku5tkrdsw",
"meter": "mtr_d9rfz7502xdyklkp9946ttci",
"payment_method": "pm_d9rfz7502xdyklkp9946ttci",
"status": "pending",
"created_at": "2024-01-01T00:00:00Z",
"start_at": null,
"terminated_at": null,
"end_at": null
}
]
}