Retrieve organizations subscriptions

TypeScript

import Nuntly from '@nuntly/sdk';

const client = new Nuntly({
  apiKey: 'My API Key',
});

const subscriptions = await client.organizations.subscriptions.list('id');

console.log(subscriptions);

{
  "data": [
    {
      "org_id": "<string>",
      "status": "active",
      "type": "plan",
      "price": {
        "unit_amount": 123,
        "currency": "<string>",
        "recurring": {
          "interval": "day",
          "interval_count": 123
        }
      },
      "current_period_start": "<string>",
      "current_period_end": "<string>",
      "cancel_at": "<string>",
      "cancel_at_period_end": true,
      "plan": "free",
      "addon": "dedicated-ips",
      "quota": {
        "monthly": {
          "transac_emails": 123
        },
        "daily": {
          "transac_emails": 123
        }
      },
      "schedule": {
        "created": "<string>",
        "phases": [
          {
            "price": {
              "unit_amount": 123,
              "currency": "<string>",
              "recurring": {
                "interval": "day",
                "interval_count": 123
              },
              "type": "plan",
              "plan": "free",
              "quota": {
                "monthly": {
                  "transac_emails": 123
                },
                "daily": {
                  "transac_emails": 123
                }
              }
            }
          }
        ]
      }
    }
  ]
}

GET

organizations

{id}

subscriptions

TypeScript

import Nuntly from '@nuntly/sdk';

const client = new Nuntly({
  apiKey: 'My API Key',
});

const subscriptions = await client.organizations.subscriptions.list('id');

console.log(subscriptions);

{
  "data": [
    {
      "org_id": "<string>",
      "status": "active",
      "type": "plan",
      "price": {
        "unit_amount": 123,
        "currency": "<string>",
        "recurring": {
          "interval": "day",
          "interval_count": 123
        }
      },
      "current_period_start": "<string>",
      "current_period_end": "<string>",
      "cancel_at": "<string>",
      "cancel_at_period_end": true,
      "plan": "free",
      "addon": "dedicated-ips",
      "quota": {
        "monthly": {
          "transac_emails": 123
        },
        "daily": {
          "transac_emails": 123
        }
      },
      "schedule": {
        "created": "<string>",
        "phases": [
          {
            "price": {
              "unit_amount": 123,
              "currency": "<string>",
              "recurring": {
                "interval": "day",
                "interval_count": 123
              },
              "type": "plan",
              "plan": "free",
              "quota": {
                "monthly": {
                  "transac_emails": 123
                },
                "daily": {
                  "transac_emails": 123
                }
              }
            }
          }
        ]
      }
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer HTTP authentication. Allowed headers Authorization: Bearer <API_KEY>

Path Parameters

string

required

The organization id previously created

Response

A successful response

data

object[]

Show child attributes

data.org_id

string

required

The id of the organization

data.status

enum<string>

required

The status of the subscription (plan or addon

Available options:

active,

canceled,

incomplete,

incomplete_expired,

past_due,

paused,

trialing,

unpaid

data.type

enum<string>

required

The type of the subscription

Available options:

plan,

addon

data.price

object

required

Show child attributes

data.price.unit_amount

number | null

required

The unit amount in cents (or local equivalent) to be charged

data.price.currency

string

required

ISO currency code

data.price.recurring

object

required

Show child attributes

data.price.recurring.interval

enum<string>

The frequency at which a subscription is billed.

Available options:

day,

month,

week,

year

data.price.recurring.interval_count

number

The number of intervals between subscription billings

data.current_period_start

string

required

Start of the current period that the subscription has been invoiced for

data.current_period_end

string

required

End of the current period that the subscription has been invoiced for

data.cancel_at

string | null

required

If the subscription has been canceled, the date of that cancellation

data.cancel_at_period_end

boolean

required

Whether this subscription will or did cancel at the end of the current billing period

data.plan

enum<string>

The name of the plan

Available options:

free,

starter,

scale,

enterprise

data.addon

enum<string>

The name of the addon

Available options:

dedicated-ips

data.quota

object

Show child attributes

data.quota.monthly

object

required

Show child attributes

data.quota.monthly.transac_emails

number

required

The quota of the emails subscribed (if applicable)

data.quota.daily

object

required

Show child attributes

data.quota.daily.transac_emails

number

required

The quota of the emails subscribed (if applicable)

data.schedule

object

Show child attributes

data.schedule.created

string

required

The date of the creation of the schedule

data.schedule.phases

object[]

required

Show child attributes

data.schedule.phases.price

object

required

Show child attributes

data.schedule.phases.price.unit_amount

number | null

required

The unit amount in cents (or local equivalent) to be charged

data.schedule.phases.price.currency

string

required

ISO currency code

data.schedule.phases.price.recurring

object

required

Show child attributes

data.schedule.phases.price.recurring.interval

enum<string>

The frequency at which a subscription is billed.

Available options:

day,

month,

week,

year

data.schedule.phases.price.recurring.interval_count

number

The number of intervals between subscription billings

data.schedule.phases.price.type

enum<string>

required

The type of the subscription

Available options:

plan,

addon

data.schedule.phases.price.plan

enum<string>

The name of the plan

Available options:

free,

starter,

scale,

enterprise

data.schedule.phases.price.quota

object

Show child attributes

data.schedule.phases.price.quota.monthly

object

required

Show child attributes

data.schedule.phases.price.quota.monthly.transac_emails

number

required

The quota of the emails subscribed (if applicable)

data.schedule.phases.price.quota.daily

object

required

Show child attributes

data.schedule.phases.price.quota.daily.transac_emails

number

required

The quota of the emails subscribed (if applicable)

List Organizations Retrieve organizations usage

⌘I

Using the Nuntly API

Emails

API Keys

Domains

Webhooks

Webhooks Events

Account

Organizations

Memberships

Invitations

Retrieve organizations subscriptions

Authorizations

Path Parameters

Response