Fields

All resources are represented by a unique, Vindicia identifier - a vid. Many resources also provide an id field for you to record your unique identifier which can contain any alphanumeric character but must not contain a /. When referring to a resource either the vid or the id may be used. GET https://api.vindicia.com/transactions/:id GET https://api.vindicia.com/transactions/:vid Resources also have an object field which represents the resource type.

Example Call

{
    "object" : "Transaction",
    "id" : "tx_1234",
    "vid" : "40f24148bdc282640b46ad281eec31f7dfd9202e",
    "created" : "2020-01-01T00:55:47Z",
    "url" : "/transactions/tx_1234"
}

Timestamps

All timestamps are represented in ISO8601 format. Timestamps may be submitted in any timezone but will be returned in UTC Time standard.

Strings

All strings are 1,024 characters unless otherwise noted. Submitting values in excess of this limit will return an error.

Enumerable Values

Some fields like object have a constant set of values. Submitting any value other than those documented will result in an error being returned with a status code of 400.

Arrays and Lists

The API returns multiple resources as list objects containing JSON array. Lists provide the ability to sparsely represent the resources they contain. Additional data can be accessed through pagination.

Example Request (Excerpt)

{
    "object" : "Subscription",
    "id" : "sub_1234",

    "items": [
       {
        "object": "SubscriptionItem",
        "id": "sub_1234.1",
        "product": {
            "object": "Product",
            "id": "prod_1234"
        }
       },
       {
        "object": "SubscriptionItem",
        "id": "sub_1234.2",
        "product": {
            "object": "Product",
            "id": "prod_1235"
        }
       }
      ]
      ...
}

Example Response (Excerpt)

{
    "items": {
        "object": "List",
        "data": [
           {
            "object": "SubscriptionItem",
            "id": "sub_1234.1",
            "index": 0,
            "product": {...},
            "quantity": 1,
            "created": "2020-05-27T05:52:02-07:00",
            "starts": "2020-05-27T00:00:00-07:00"
           },
           {
            "object": "SubscriptionItem",
            "id": "sub_1234.2",
            "index": 0,
            "product": {...},
            "quantity": 1,
            "created": "2020-05-27T05:52:02-07:00",
            "starts": "2020-05-27T00:00:00-07:00"
           }
        ],
    "total_count": 2
}

Parent topic:Interacting with the API

Home

Guides

APIs

Example Call

Timestamps

Strings

Enumerable Values

Arrays and Lists

Example Request (Excerpt)

Example Response (Excerpt)

​Example Call

​Timestamps

​Strings

​Enumerable Values

​Arrays and Lists

​Example Request (Excerpt)

​Example Response (Excerpt)

Example Call

Timestamps

Strings

Enumerable Values

Arrays and Lists

Example Request (Excerpt)

Example Response (Excerpt)