Skip to main content
Vindicia Knowledge Center

Expanding Objects

Expanding Objects

Expansion options may be limited during the *Beta* release periods for the REST API. Full support will be included in the final initial REST API Release.

Many objects contain the ID of a related object in their response properties. For example, a Subscription may have an associated Account Id. Those objects can be expanded inline with the expand request parameter. Objects that can be expanded are noted in this documentation. This parameter is available on all API requests, and applies to the response of that request only. You can nest expand requests with the dot property. For example, requesting account.shipping_address on a Subscription will expand the Account property into a full Account object, and will then expand the shipping_address property on that Account into a full shipping_address object. You can expand multiple objects at once by identifying multiple items in the expand array.

  • cURL
  • Java
Example Object
{
  "object" : "Subscription",
  "account" : "cust_1234"
}
Example Expanded Object
{
  "object" : "Subscription",
    "account" : {
        "object" : "Account",
        "id" : "cust_1234",
        "vid" : "29cb0e8d4a10f3f351ed21826f2c0398858238b2",
        "name" : "Charlie Brown",
        "shipping_address" : {
            "line1" : "123 Main St.",
            "city" : "Jamestown",
            "district" : "NY",
            "postal_code" : "12345",
            "country" : "US"
        },
        "email" : "charlie.brown@peanuts.com",
        "email_type" : "html",
        "language" : "en-US",
        "currency" : "USD",
        "notify_before_billing" : true,
        "url" : "/accounts/acct_1234"
    }
}
{
  "object" : "Subscription",
  "account" : "cust_1234"
}
Example Expanded Object
{
  "object" : "Subscription",
    "account" : {
        "object" : "Account",
        "id" : "cust_1234",
        "vid" : "29cb0e8d4a10f3f351ed21826f2c0398858238b2",
        "name" : "Charlie Brown",
        "shipping_address" : {
            "line1" : "123 Main St.",
            "city" : "Jamestown",
            "district" : "NY",
            "postal_code" : "12345",
            "country" : "US"
        },
        "email" : "charlie.brown@peanuts.com",
        "email_type" : "html",
        "language" : "en-US",
        "currency" : "USD",
        "notify_before_billing" : true,
        "url" : "/accounts/acct_1234"
    }
}

For Users

Learn More
For Users

Cashbox Features

Learn More
Cashbox Features
Back to Top