GET PLAN

Search…

GET PLAN

Query for the subscription information associated with the given customer subscription ID

get
https://api.eyelevel.ai/v1/partner
/subscription/:apiKey/:subscriptionId
QUERY
Response
{
    "subscription": {
        "amount":            INTEGER,
        "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.
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.

UPDATE PAYMENT SOURCE

GET ALL PLANS

Last modified 1yr ago

Copy link

On this page

get

QUERY

Response

amount

anchor

cancelAt

currency

interval

name

subscriptionId

subscriptionStart

trialEnd