Skip to main content
Vindicia Knowledge Center

Fields

Fields

IDs and Referencing Other Objects

All resources are represented by a unique, Vindicia identifier - a vid. Many resources also provide an optional id field for you to record your unique identifier. 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 and many include a url field for the location under api.vindicia.com.

Timestamps

All timestamps are represented in ISO8601 format. Timestamps may be submitted in any timezone but will be returned in US-PACIFIC (UTC Time standard pending).

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.

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

Arrays and Lists

  • cURL
  • Java
Example Object
{
    "object" : "Transaction",
    "id" : "tx_1234",
    "vid" : "40f24148bdc282640b46ad281eec31f7dfd9202e",
    "created" : "2016-01-01T00:55:47Z",
    "url" : "/transactions/tx_1234"
}
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": "2016-05-27T05:52:02-07:00",
            "starts": "2016-05-27T00:00:00-07:00"
           },
           {
            "object": "SubscriptionItem",
            "id": "sub_1234.2",
            "index": 0,
            "product": {`...`},
            "quantity": 1,
            "created": "2016-05-27T05:52:02-07:00",
            "starts": "2016-05-27T00:00:00-07:00"
           }
        ],
    "total_count": 2
},
{
    "object" : "Transaction",
    "id" : "tx_1234",
    "vid" : "40f24148bdc282640b46ad281eec31f7dfd9202e",
    "created" : "2016-01-01T00:55:47Z",
    "url" : "/transactions/tx_1234"
}
        
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": "2016-05-27T05:52:02-07:00",
            "starts": "2016-05-27T00:00:00-07:00"
           },
           {
            "object": "SubscriptionItem",
            "id": "sub_1234.2",
            "index": 0,
            "product": {`...`},
            "quantity": 1,
            "created": "2016-05-27T05:52:02-07:00",
            "starts": "2016-05-27T00:00:00-07:00"
           }
        ],
    "total_count": 2
},

For Users

Learn More
For Users

Cashbox Features

Learn More
Cashbox Features
Back to Top