List invoices

GET

/invoices

const url = 'https://api.nsin.ir/invoices';
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 \
  --header 'Authorization: Bearer <token>'

Authorizations

bearerAuth
apiKeyAuth

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

string

Allowed values: subscription topup manual

status

string

Allowed values: paid unpaid cancelled

subtotal_rials

integer

tax_rials

integer

total_rials

integer

issued_at

string format: date-time

paid_at

string 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 — or the owning account is inactive.

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"
}