Get a subscription, or search them across products
eurodns_subscription_getRetrieve full subscription details by ID and product, list subscriptions for a product, or search all subscriptions with filters.
Instructions
Returns one subscription in full when product and id are given — an SSL subscription with its certificates, a mailbox with its aliases, a Premium DNS, Microsoft or HTTPS redirect term — lists one product’s subscriptions when only product is given, or searches every product when both are omitted. Start with the cross-product search for an expiry review, then narrow by product. It reads records only and manages nothing behind them; a filter marked for another product is ignored, and an id without product is refused before any call, since ids repeat across products. Its ids feed eurodns_ssl_get_certificate and eurodns_email_set_alias.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Numeric id of one subscription of the chosen product, from a previous search, to return in full. Omit it to list or search instead. | |
| page | No | 1-based page number. There is no page meaning everything: walk pages until a short one comes back. | |
| size | No | Results per page, 1 to 500. A wide page is truncated by the character limit, so prefer a filter to a large size. | |
| product | No | Which product to read: ssl, email, premium_dns, microsoft or https_redirect. Omit it to search every product at once with the common filters; required whenever id is given, because ids are only unique within a product. | |
| sanName | No | ssl only: a Subject Alternative Name of a certificate in the subscription. | |
| userName | No | email only: the mailbox user name, the part before the @. | |
| renewable | No | ssl only: true keeps subscriptions that can still be renewed. | |
| sortField | No | Result field to sort on, spelled as in the response items. Unsorted when omitted. | |
| sortOrder | No | ASC or DESC; only read with sortField. | |
| commonName | No | ssl only: the common name of a certificate in the subscription. | |
| domainName | No | Keep only subscriptions attached to this domain, e.g. example.com. Read by the cross-product search and by the email and premium_dns listings; use microsoftDomain for Microsoft. | |
| accountLabel | No | microsoft only: the account label the subscription was created under. | |
| microsoftDomain | No | microsoft only: the Microsoft 365 domain of the subscription. | |
| autoRenewEnabled | No | Cross-product search only: true keeps subscriptions that renew themselves, false only those that will lapse. | |
| subscriptionTypes | No | Cross-product search only: keep these products, e.g. ["SSL", "EMAIL"]. Ignored when product is given, which already selects one. | |
| subscriptionStatus | No | Keep only subscriptions in this lifecycle status, e.g. ACTIVE, TO_RENEW or PROVISIONING, for any product. Omit for every status. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | Yes | Response body as returned by the API. | |
| status | Yes | Upstream HTTP status code. |