UPDATE BILLING INFO

Update the billing information for the given customer API key

UPDATE

POST https://api.eyelevel.ai/v1/partner/subscription/billing/:apiKey

Path Parameters

NameTypeDescription

apiKey

string

EyeLevel customer key

Request Body

NameTypeDescription

subscription

object

See request definition below

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

Request

{
    "subscription": {
        "billingEmail": "STRING",
        "billingName":  "STRING"
    }
}

billingEmail

OPTIONAL - String

Validation: Valid email

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

billingName

OPTIONAL - String

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

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.

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 id 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.

Last updated