List subscriptions

GET 
/clients/subscriptions

JSON-RPC

clients.subscriptions.search

Status vs Condition

Subscription status represents current state of the subscription. It is calculated according to package condition, start_dt and stop_dt of the package, and status of the last period.

Possible values:

• active – subscription is activated and there is an active period at the current moment.
• pending – subscription is not activated or doesn't have an active period at the current moment, but still not deactivated.
• archive – subscription is deactivated, stop_dt of the package has passed or renew_due is already in the past.

Request

application/json

Bodyrequired

limitinteger

Number of rows to return (for pagination).

Default value: 20

offsetinteger

Number of rows to skip (for pagination).

Default value: 0

orderstring[]

List of columns to order results by.

Possible values: [clients_name, -clients_name, id, -id, packages_name, -packages_name, periods_start_dt, -periods_start_dt, start_dt, -start_dt, status, -status]

Default value: []

qstring

Quick search (wildcards allowed).

idinteger[]

Subscription ID.

clients_idinteger[]

Client ID.

accounts_idinteger[]

Account ID.

packages_idinteger[]

Package ID.

companies_idinteger[]

Partition ID of the client.

owner_users_idinteger

Owner user ID of the client.

statusstring[]

Real status at the current moment.

Possible values: [pending, active, archive]

conditionstring

Subscription condition. Check method description for more details on the difference between condition and status.

Possible values: [new, activated, deactivated]

Responses

200

List of subscription objects.

application/json

Schema

Schema

Array [
object
]

Example (auto)

[
  {}
]

400

The request contains invalid arguments or is malformed

application/json

Schema

Schema

error object
messagestring
Error message
Example: Invalid request
dataobject
Details for validation errors (if applicable)
Example: {"name":"Empty value is not allowed","payment_terms_id":"Object \"payment_terms(123)\" was not found!"}

Example (auto)

{
  "error": {
    "message": "Invalid request",
    "data": {
      "name": "Empty value is not allowed",
      "payment_terms_id": "Object \"payment_terms(123)\" was not found!"
    }
  }
}

401

Access is not authorized

application/json

Schema

Schema

error object
messagestring
Example: utoken-auth-failed: Authentication Failed: IP 10.0.0.1 is not allowed
data object
codestring
Error code
Example: utoken-auth-failed
messagestring
Example: Authentication Failed: IP 10.0.0.1 is not allowed

Example (auto)

{
  "error": {
    "message": "utoken-auth-failed: Authentication Failed: IP 10.0.0.1 is not allowed",
    "data": {
      "code": "utoken-auth-failed",
      "message": "Authentication Failed: IP 10.0.0.1 is not allowed"
    }
  }
}

404

Requested object was not found

application/json

Schema

Schema

error object
messagestring
Example: not_found: Object "clients(123)" was not found!
data object
codestring
Error code (static: not_found)
Example: not_found
messagestring
Error message
Example: Object "clients(123)" was not found!
object_namestring
Type of the object
Example: clients
object_idstring
ID of the object
Example: 123

Example (auto)

{
  "error": {
    "message": "not_found: Object \"clients(123)\" was not found!",
    "data": {
      "code": "not_found",
      "message": "Object \"clients(123)\" was not found!",
      "object_name": "clients",
      "object_id": "123"
    }
  }
}

422

A logical error occurred, making the request unprocessable

application/json

Schema

Schema

error object
messagestring
Error message
Example: invoices-zero-amount: Impossible to create an invoice with zero amount
data object
codestring
Error code
Example: invoices-zero-amount
messagestring
Error message
Example: Impossible to create an invoice with zero amount

Example (auto)

{
  "error": {
    "message": "invoices-zero-amount: Impossible to create an invoice with zero amount",
    "data": {
      "code": "invoices-zero-amount",
      "message": "Impossible to create an invoice with zero amount"
    }
  }
}

500

An unexpected error occurred

application/json

Schema

Schema

error object
messagestring
Error message
Example: An unexpected error occurred

Example (auto)

{
  "error": {
    "message": "An unexpected error occurred"
  }
}

Authorization: X-Api-Key

name: X-Api-Keytype: apiKeyin: headerdescription: Token for API access

• curl
• python
• nodejs
• php

• CURL

curl -L 'https://docs.jerasoft.net/clients/subscriptions' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'X-Api-Key: <X-Api-Key>'

Request Collapse all

Auth

ApiKeyAuth

Body required

{
  "limit": 20,
  "offset": 0,
  "order": [
    "clients_name"
  ],
  "q": "string",
  "id": [
    0
  ],
  "clients_id": [
    0
  ],
  "accounts_id": [
    0
  ],
  "packages_id": [
    0
  ],
  "companies_id": [
    0
  ],
  "owner_users_id": 0,
  "status": [
    "pending"
  ],
  "condition": "new"
}