Namespace License

Creates a license, given a plan and email. Called asynchronously with await. All data is provided as-is from the server, with the addition of an ok boolean for error handling.

https://docs.hyper.co/reference/create-license

import { Client, License } from 'hyper'
const client = Hyper('my-api-key')

let body = {
plan: "plan-123",
email: "admin@hyper.co"
}

const res = await License.create(client, body)

Deletes a license, given its key. Called asynchronously with await. All data is provided as-is from the server, with the addition of an ok boolean for error handling.

https://docs.hyper.co/reference/delete-license

import { Client, License } from 'hyper'
const client = Hyper('my-api-key')

let license = "FOO-1111-2222-3333-4444"

const res = await License.destroy(client)

Retrieves a license, given its key. Called asynchronously with await. All data is provided as-is from the server, with the addition of an ok boolean for error handling.

https://docs.hyper.co/reference/retrieve-license

import { Client, License } from 'hyper'
const client = Hyper('my-api-key')

let license = "FOO-1111-2222-3333-4444"

const res = await License.get(client, license)

Lists all licenses. Called asynchronously with await. All data is provided as-is from the server, with the addition of an ok boolean for error handling.

https://docs.hyper.co/reference/list-licenses

import { Client, License } from 'hyper'
const client = Hyper('my-api-key')

// Page 1
const res = await License.list(client)

// Note: HyperApiPaginatedResponse .next() and .previous() return null once you reach a nonexisting page.

// Page 2
res.next()

// Page 1
res.previous()

Updates a license, given its key and new value(s). Called asynchronously with await. All data is provided as-is from the server, with the addition of an ok boolean for error handling.

https://docs.hyper.co/reference/update-license

import { Client, License } from 'hyper'
const client = Hyper('my-api-key')

let license = "FOO-1111-2222-3333-4444"

let body = {
email: "admin@hyper.co",
subscription: {
"cancel_at_period_end": false
}
}

const res = await License.update(client, license, body)

Updates a license's metadata, given its key. Called asynchronously with await. All data is provided as-is from the server, with the addition of an ok boolean for error handling.

https://docs.hyper.co/reference/update-license-metadata

import { Client, License } from 'hyper'
const client = Hyper('my-api-key')

let license = "FOO-1111-2222-3333-4444"

let metadata = {
foo: 'bar' // values MUST be strings
}

const res = await License.updateMetadata(client, license, metadata)