GET SUBSCRIPTION

Query for the subscription associated with the given customer API key

QUERY

GET https://api.eyelevel.ai/v1/partner/subscription/:apiKey

Path Parameters

Name	Type	Description
apiKey	string	EyeLevel customer key

200

{
    "subscription": {
        "amount":            INTEGER,
        "billingEmail":      "STRING",
        "billingName":       "STRING",
        "cancelAt":          DATETIME,
        "currency":          "ENUMERATED STRING",
        "interval":          "ENUMERATED STRING",
        "name":              "STRING",
        "subscriptionId":    "STRING IDENTIFIER",
        "subscriptionStart": DATETIME,
        "trialEnd":          DATETIME
    }
}

Response

{
    "subscription": {
        "amount":            INTEGER,
        "billingEmail":      "STRING",
        "billingName":       "STRING",
        "cancelAt":          DATETIME,
        "currency":          "ENUMERATED STRING",
        "interval":          "ENUMERATED STRING",
        "name":              "STRING",
        "subscriptionId":    "STRING IDENTIFIER",
        "subscriptionStart": DATETIME,
        "trialEnd":          DATETIME
    }
}

amount

The price in cents (represented as a whole integer if possible) of the subscription plan per month or per year.

anchor

The datetime in RFC3339 format that billing periods are based off of.

billingEmail

The email address that invoices will be sent to. Defaults to the EyeLevel customer email.

billingName

The name that invoices will be addressed to. Defaults to the EyeLevel customer name.

cancelAt

The datetime in RFC3339 format when the subscription will end.

currency

Three-letter ISO currency code, in lowercase. Must be a supported currency.

interval

The frequency of billing periods, either month or year.

name

The human readable name for the subscription plan.

subscriptionId

The unique identifier for the subscription. You can use this subscriptionId in other subscription API requests.

subscriptionStart

The datetime in RFC3339 format when the subscription was started.

trialEnd

The datetime in RFC3339 format when the trial period for the subscription ends.