Organization

Users[] · required

name

string · minLength: 1 · maxLength: 200 · required

contact_email

string · email · minLength: 1 · maxLength: 200 · required

contact_phone

string · minLength: 1 · maxLength: 200 · required

id

string · uuid

address

string | null

is_active

boolean

contact_name

string · minLength: 1 · maxLength: 200

calendar_link

string · minLength: 1 · maxLength: 200

Update org settings › Responses

Users[] · required

name

string · minLength: 1 · maxLength: 200 · required

contact_email

string · email · minLength: 1 · maxLength: 200 · required

contact_phone

string · minLength: 1 · maxLength: 200 · required

id

string · uuid

address

string | null

is_active

boolean

contact_name

string · minLength: 1 · maxLength: 200

calendar_link

string · minLength: 1 · maxLength: 200

PUT/org/{org_id}/settings/

curl https://nervai.hrmless.com/api/v1/org/:org_id/settings \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: <api-key>' \
  --data '{
  "id": "00000000-0000-0000-0000-000000000000",
  "referrals": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "email": "[email protected]",
      "first_name": "first_name",
      "last_name": "last_name",
      "role": "role",
      "phone": "phone",
      "enabled": true,
      "organization": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "account_managers": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "email": "[email protected]",
      "first_name": "first_name",
      "last_name": "last_name",
      "role": "role",
      "phone": "phone",
      "enabled": true,
      "organization": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "kombo_integrations": [
    {
      "integration_id": "integration_id",
      "organization": "00000000-0000-0000-0000-000000000000",
      "status": "status",
      "auto_move_stages": true,
      "updated_at": "2024-08-25T15:00:00Z",
      "last_synced": "2024-08-25T15:00:00Z",
      "candidate_stage": "candidate_stage",
      "passed_stage": "passed_stage",
      "rejected_stage": "rejected_stage",
      "needs_reviewed_stage": "needs_reviewed_stage"
    }
  ],
  "name": "name",
  "contact_email": "[email protected]",
  "contact_phone": "contact_phone",
  "address": "address",
  "is_active": true,
  "contact_name": "contact_name",
  "calendar_link": "calendar_link"
}'

Example Request Body

{
  "id": "00000000-0000-0000-0000-000000000000",
  "referrals": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "email": "[email protected]",
      "first_name": "first_name",
      "last_name": "last_name",
      "role": "role",
      "phone": "phone",
      "enabled": true,
      "organization": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "account_managers": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "email": "[email protected]",
      "first_name": "first_name",
      "last_name": "last_name",
      "role": "role",
      "phone": "phone",
      "enabled": true,
      "organization": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "kombo_integrations": [
    {
      "integration_id": "integration_id",
      "organization": "00000000-0000-0000-0000-000000000000",
      "status": "status",
      "auto_move_stages": true,
      "updated_at": "2024-08-25T15:00:00Z",
      "last_synced": "2024-08-25T15:00:00Z",
      "candidate_stage": "candidate_stage",
      "passed_stage": "passed_stage",
      "rejected_stage": "rejected_stage",
      "needs_reviewed_stage": "needs_reviewed_stage"
    }
  ],
  "name": "name",
  "contact_email": "[email protected]",
  "contact_phone": "contact_phone",
  "address": "address",
  "is_active": true,
  "contact_name": "contact_name",
  "calendar_link": "calendar_link"
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "referrals": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "email": "[email protected]",
      "first_name": "first_name",
      "last_name": "last_name",
      "role": "role",
      "phone": "phone",
      "enabled": true,
      "organization": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "account_managers": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "email": "[email protected]",
      "first_name": "first_name",
      "last_name": "last_name",
      "role": "role",
      "phone": "phone",
      "enabled": true,
      "organization": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "kombo_integrations": [
    {
      "integration_id": "integration_id",
      "organization": "00000000-0000-0000-0000-000000000000",
      "status": "status",
      "auto_move_stages": true,
      "updated_at": "2024-08-25T15:00:00Z",
      "last_synced": "2024-08-25T15:00:00Z",
      "candidate_stage": "candidate_stage",
      "passed_stage": "passed_stage",
      "rejected_stage": "rejected_stage",
      "needs_reviewed_stage": "needs_reviewed_stage"
    }
  ],
  "name": "name",
  "contact_email": "[email protected]",
  "contact_phone": "contact_phone",
  "address": "address",
  "is_active": true,
  "contact_name": "contact_name",
  "calendar_link": "calendar_link"
}

json

application/json

Get subscription status

GET

https://nervai.hrmless.com/api/v1

/auth/validate_subscription

This method is used to validate your subscription status. It checks if your subscription is active, past due, canceled, or unpaid. It is also useful to get the required details for other subscription API calls.

Get subscription status › Responses

Successful response

subscription_id

string

price_id

string

customer_id

string

status

string

Get subscription details

GET

https://nervai.hrmless.com/api/v1

/org/{org_id}/get_subscription

This method is used to get your subscription details by your Stripe customer ID. Your Stripe customer ID can be found using the Get Subscription Status endpoint.

Get subscription details › path Parameters

org_id

string · required

Get subscription details › query Parameters

customer_id

string · minLength: 1 · required

Get subscription details › Responses

SubscriptionListResponse

object

string · minLength: 1 · required

SubscriptionResponse[] · required

has_more

boolean · required

url

string · minLength: 1 · required

GET/org/{org_id}/get_subscription

curl 'https://nervai.hrmless.com/api/v1/org/:org_id/get_subscription?customer_id=<string>' \
  --header 'Authorization: <api-key>'

Example Responses

{
  "object": "object",
  "data": [
    {
      "id": "id",
      "object": "object",
      "application": "application",
      "application_fee_percent": "application_fee_percent",
      "automatic_tax": {
        "disabled_reason": "disabled_reason",
        "enabled": true,
        "liability": "liability"
      },
      "billing_cycle_anchor": 0,
      "billing_cycle_anchor_config": "billing_cycle_anchor_config",
      "billing_thresholds": "billing_thresholds",
      "cancel_at": "cancel_at",
      "cancel_at_period_end": true,
      "canceled_at": "canceled_at",
      "cancellation_details": {
        "comment": "comment",
        "feedback": "feedback",
        "reason": "reason"
      },
      "collection_method": "collection_method",
      "created": 0,
      "currency": "currency",
      "customer": "customer",
      "days_until_due": "days_until_due",
      "default_payment_method": "default_payment_method",
      "default_source": "default_source",
      "default_tax_rates": [
        "string"
      ],
      "description": "description",
      "discounts": [
        "string"
      ],
      "ended_at": "ended_at",
      "invoice_settings": {
        "account_tax_ids": "account_tax_ids",
        "issuer": {
          "type": "type"
        }
      },
      "items": {
        "object": "object",
        "data": [
          {
            "id": "id",
            "object": "object",
            "billing_thresholds": "billing_thresholds",
            "created": 0,
            "current_period_end": 0,
            "current_period_start": 0,
            "discounts": [
              "string"
            ],
            "metadata": {},
            "plan": {
              "id": "id",
              "object": "object",
              "active": true,
              "amount": 0,
              "amount_decimal": "amount_decimal",
              "billing_scheme": "billing_scheme",
              "created": 0,
              "currency": "currency",
              "interval": "interval",
              "interval_count": 0,
              "livemode": true,
              "metadata": {},
              "meter": "meter",
              "nickname": "nickname",
              "product": "product",
              "tiers_mode": "tiers_mode",
              "transform_usage": "transform_usage",
              "trial_period_days": 0,
              "usage_type": "usage_type"
            },
            "price": {
              "id": "id",
              "object": "object",
              "active": true,
              "billing_scheme": "billing_scheme",
              "created": 0,
              "currency": "currency",
              "custom_unit_amount": "custom_unit_amount",
              "livemode": true,
              "lookup_key": "lookup_key",
              "metadata": {},
              "nickname": "nickname",
              "product": "product",
              "recurring": {
                "interval": "interval",
                "interval_count": 0,
                "meter": "meter",
                "trial_period_days": 0,
                "usage_type": "usage_type"
              },
              "tax_behavior": "tax_behavior",
              "tiers_mode": "tiers_mode",
              "transform_quantity": "transform_quantity",
              "type": "type",
              "unit_amount": 0,
              "unit_amount_decimal": "unit_amount_decimal"
            },
            "quantity": 0,
            "subscription": "subscription",
            "tax_rates": [
              "string"
            ]
          }
        ],
        "has_more": true,
        "total_count": 0,
        "url": "url"
      },
      "latest_invoice": "latest_invoice",
      "livemode": true,
      "metadata": {},
      "next_pending_invoice_item_invoice": "next_pending_invoice_item_invoice",
      "on_behalf_of": "on_behalf_of",
      "pause_collection": "pause_collection",
      "payment_settings": {
        "payment_method_options": "payment_method_options",
        "payment_method_types": "payment_method_types",
        "save_default_payment_method": "save_default_payment_method"
      },
      "pending_invoice_item_interval": "pending_invoice_item_interval",
      "pending_setup_intent": "pending_setup_intent",
      "pending_update": "pending_update",
      "plan": {
        "id": "id",
        "object": "object",
        "active": true,
        "amount": 0,
        "amount_decimal": "amount_decimal",
        "billing_scheme": "billing_scheme",
        "created": 0,
        "currency": "currency",
        "interval": "interval",
        "interval_count": 0,
        "livemode": true,
        "metadata": {},
        "meter": "meter",
        "nickname": "nickname",
        "product": "product",
        "tiers_mode": "tiers_mode",
        "transform_usage": "transform_usage",
        "trial_period_days": 0,
        "usage_type": "usage_type"
      },
      "quantity": 0,
      "schedule": "schedule",
      "start_date": 0,
      "status": "status",
      "test_clock": "test_clock",
      "transfer_data": "transfer_data",
      "trial_end": "trial_end",
      "trial_settings": {
        "end_behavior": {
          "missing_payment_method": "missing_payment_method"
        }
      },
      "trial_start": "trial_start"
    }
  ],
  "has_more": true,
  "url": "url"
}

json

application/json

Get subscription usage

GET

https://nervai.hrmless.com/api/v1

/org/{org_id}/subscription/{subscription_id}/usage

Retrieves usage for the current billing cycle.

Get subscription usage › path Parameters

org_id

string · required

subscription_id

string · required

Get subscription usage › Responses

200

Usage Records

Preview invoice

POST

https://nervai.hrmless.com/api/v1

/org/{org_id}/preview_invoice

This method is used to preview the next invoice for your organization based on your current usage.

Preview invoice › path Parameters

org_id

string · required

Preview invoice › Request Body

CustomerInvoice

customer_id

string · minLength: 1 · required

subscription_id

string · minLength: 1 · required

Preview invoice › Responses

InvoiceResponse

id

string · minLength: 1 · required

object

string · minLength: 1 · required

account_country

string · minLength: 1 · required

account_name

string · minLength: 1 · required

account_tax_ids

string | null · minLength: 1 · required

amount_due

integer · required

amount_overpaid

integer · required

amount_paid

integer · required

amount_remaining

integer · required

amount_shipping

integer · required

application

string | null · minLength: 1 · required

attempt_count

integer · required

attempted

boolean · required

auto_advance

boolean · required

AutomaticTax · required

automatically_finalizes_at

string | null · minLength: 1 · required

billing_reason

string · minLength: 1 · required

collection_method

string · minLength: 1 · required

created

integer · required

currency

string · minLength: 1 · required

custom_fields

string | null · minLength: 1 · required

customer

string · minLength: 1 · required

customer_address

string | null · minLength: 1 · required

customer_email

string · email · minLength: 1 · required

customer_name

string · minLength: 1 · required

customer_phone

string | null · minLength: 1 · required

customer_shipping

string | null · minLength: 1 · required

customer_tax_exempt

string · minLength: 1 · required

customer_tax_ids

(string | null)[] · required

default_payment_method

string | null · minLength: 1 · required

default_source

string | null · minLength: 1 · required

default_tax_rates

(string | null)[] · required

description

string | null · minLength: 1 · required

discounts

(string | null)[] · required

due_date

string | null · minLength: 1 · required

effective_at

string | null · minLength: 1 · required

ending_balance

integer · required

footer

string | null · minLength: 1 · required

from_invoice

string | null · minLength: 1 · required

hosted_invoice_url

string | null · minLength: 1 · required

invoice_pdf

string | null · minLength: 1 · required

Issuer · required

last_finalization_error

string | null · minLength: 1 · required

latest_revision

string | null · minLength: 1 · required

Lines · required

livemode

boolean · required

metadata

object · required

next_payment_attempt

integer · required

number

string | null · minLength: 1 · required

on_behalf_of

string | null · minLength: 1 · required

InvoiceParent · required

NewPaymentSettings · required

period_end

integer · required

period_start

integer · required

post_payment_credit_notes_amount

integer · required

pre_payment_credit_notes_amount

integer · required

receipt_number

string | null · minLength: 1 · required

rendering

string | null · minLength: 1 · required

shipping_cost

string | null · minLength: 1 · required

shipping_details

string | null · minLength: 1 · required

starting_balance

integer · required

statement_descriptor

string | null · minLength: 1 · required

status

string · minLength: 1 · required

StatusTransitions · required

subtotal

integer · required

subtotal_excluding_tax

integer · required

test_clock

string | null · minLength: 1 · required

total

integer · required

total_discount_amounts

(string | null)[] · required

total_excluding_tax

integer · required

total_pretax_credit_amounts

(string | null)[] · required

total_taxes

(string | null)[] · required

webhooks_delivered_at

string | null · minLength: 1 · required

POST/org/{org_id}/preview_invoice

curl https://nervai.hrmless.com/api/v1/org/:org_id/preview_invoice \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: <api-key>' \
  --data '{
  "customer_id": "customer_id",
  "subscription_id": "subscription_id"
}'

Example Request Body

{
  "customer_id": "customer_id",
  "subscription_id": "subscription_id"
}

json

Example Responses

{
  "id": "id",
  "object": "object",
  "account_country": "account_country",
  "account_name": "account_name",
  "account_tax_ids": "account_tax_ids",
  "amount_due": 0,
  "amount_overpaid": 0,
  "amount_paid": 0,
  "amount_remaining": 0,
  "amount_shipping": 0,
  "application": "application",
  "attempt_count": 0,
  "attempted": true,
  "auto_advance": true,
  "automatic_tax": {
    "disabled_reason": "disabled_reason",
    "enabled": true,
    "liability": "liability"
  },
  "automatically_finalizes_at": "automatically_finalizes_at",
  "billing_reason": "billing_reason",
  "collection_method": "collection_method",
  "created": 0,
  "currency": "currency",
  "custom_fields": "custom_fields",
  "customer": "customer",
  "customer_address": "customer_address",
  "customer_email": "[email protected]",
  "customer_name": "customer_name",
  "customer_phone": "customer_phone",
  "customer_shipping": "customer_shipping",
  "customer_tax_exempt": "customer_tax_exempt",
  "customer_tax_ids": [
    "string"
  ],
  "default_payment_method": "default_payment_method",
  "default_source": "default_source",
  "default_tax_rates": [
    "string"
  ],
  "description": "description",
  "discounts": [
    "string"
  ],
  "due_date": "due_date",
  "effective_at": "effective_at",
  "ending_balance": 0,
  "footer": "footer",
  "from_invoice": "from_invoice",
  "hosted_invoice_url": "hosted_invoice_url",
  "invoice_pdf": "invoice_pdf",
  "issuer": {
    "type": "type"
  },
  "last_finalization_error": "last_finalization_error",
  "latest_revision": "latest_revision",
  "lines": {
    "object": "object",
    "data": [
      {
        "id": "id",
        "object": "object",
        "amount": 0,
        "currency": "currency",
        "description": "description",
        "discount_amounts": [
          "string"
        ],
        "discountable": true,
        "discounts": [
          "string"
        ],
        "invoice": "invoice",
        "livemode": true,
        "metadata": {},
        "parent": {
          "invoice_item_details": "invoice_item_details",
          "subscription_item_details": {
            "invoice_item": "invoice_item",
            "proration": true,
            "proration_details": {
              "key": "string"
            },
            "subscription": "subscription",
            "subscription_item": "subscription_item"
          },
          "type": "type"
        },
        "period": {
          "start": 0,
          "end": 0
        },
        "pretax_credit_amounts": [
          "string"
        ],
        "pricing": {
          "price_details": {
            "price": "price",
            "product": "product"
          },
          "type": "type",
          "unit_amount_decimal": "unit_amount_decimal"
        },
        "quantity": 0,
        "taxes": [
          "string"
        ]
      }
    ],
    "has_more": true,
    "total_count": 0,
    "url": "url"
  },
  "livemode": true,
  "metadata": {},
  "next_payment_attempt": 0,
  "number": "number",
  "on_behalf_of": "on_behalf_of",
  "parent": {
    "quote_details": "quote_details",
    "subscription_details": {
      "metadata": {},
      "subscription": "subscription"
    },
    "type": "type"
  },
  "payment_settings": {
    "default_mandate": "default_mandate",
    "payment_method_options": "payment_method_options",
    "payment_method_types": "payment_method_types"
  },
  "period_end": 0,
  "period_start": 0,
  "post_payment_credit_notes_amount": 0,
  "pre_payment_credit_notes_amount": 0,
  "receipt_number": "receipt_number",
  "rendering": "rendering",
  "shipping_cost": "shipping_cost",
  "shipping_details": "shipping_details",
  "starting_balance": 0,
  "statement_descriptor": "statement_descriptor",
  "status": "status",
  "status_transitions": {
    "finalized_at": "finalized_at",
    "marked_uncollectible_at": "marked_uncollectible_at",
    "paid_at": "paid_at",
    "voided_at": "voided_at"
  },
  "subtotal": 0,
  "subtotal_excluding_tax": 0,
  "test_clock": "test_clock",
  "total": 0,
  "total_discount_amounts": [
    "string"
  ],
  "total_excluding_tax": 0,
  "total_pretax_credit_amounts": [
    "string"
  ],
  "total_taxes": [
    "string"
  ],
  "webhooks_delivered_at": "webhooks_delivered_at"
}

json

application/json

Position

Update org settings

PUT

https://nervai.hrmless.com/api/v1

/org/{org_id}/settings/

Update organization settings

Update org settings › path Parameters

org_id

string · required

Update org settings › Request Body

Users[] · required

name

string · minLength: 1 · maxLength: 200 · required

contact_email

string · email · minLength: 1 · maxLength: 200 · required

contact_phone

string · minLength: 1 · maxLength: 200 · required

id

string · uuid

address

string | null

is_active

boolean

contact_name

string · minLength: 1 · maxLength: 200

calendar_link

string · minLength: 1 · maxLength: 200

Update org settings › Responses

Users[] · required

name

string · minLength: 1 · maxLength: 200 · required

contact_email

string · email · minLength: 1 · maxLength: 200 · required

contact_phone

string · minLength: 1 · maxLength: 200 · required

id

string · uuid