List invoices

GET

/invoices

const url = 'https://api.nsin.ir/invoices?limit=200&offset=0';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.nsin.ir/invoices?limit=200&offset=0' \
  --header 'Authorization: Bearer <token>'

Your invoices across all your domains — plan purchases, renewals, top-ups and manual invoices — newest first, each with its line items. Traffic statements are not included.

Authorizations

bearerAuth
apiKeyAuth

Parameters

Query Parameters

limit

integer

default: 200 >= 1 <= 200

How many invoices to return, 1–200.

offset

integer

Responses

200

Invoices, newest first.

application/json

Array<object>

object

integer

number

Human-facing invoice number, sequential per Jalali year.

string

user_id

integer

domain_id

integer

domain_name

string

subscription_id

integer

payment_id

integer

kind

subscription — a plan purchase or renewal (taxed). period — the traffic of a closed billing period, when it had metered traffic (no VAT). topup — a wallet top-up (no VAT). manual — issued by NSIN support (taxed).

string

Allowed values: subscription period topup manual

status

string

Allowed values: paid unpaid cancelled

subtotal_rials

Before tax, in rials.

integer

tax_rials

VAT, in rials.

integer

total_rials

What was charged, in rials.

integer

issued_at

string format: date-time

paid_at

string | null format: date-time

notes

string

created_at

string format: date-time

updated_at

string format: date-time

items

Array<object>

object

integer

invoice_id

integer

description

string

quantity

integer

unit_price_rials

integer

total_rials

integer

Example

[
  {
    "kind": "subscription",
    "status": "paid"
  }
]

401

Missing, malformed, revoked or expired API key. (A valid key whose account has been deactivated gets 403 account is inactive instead.)

application/json

The single error shape used by every endpoint.

object

error

required

Human-readable description of what went wrong.

string

Examples

invalidKey

{
  "error": "invalid API key"
}

429

The key exceeded its request budget (300 requests per minute by default).

application/json

The single error shape used by every endpoint.

object

error

required

Human-readable description of what went wrong.

string

Examples

limited

{
  "error": "rate limit exceeded"
}