Skip to main content
Vindicia Knowledge Center

List all BillingPlans

List all BillingPlans

Retrieves all BillingPlans.

Route (URL) Parameters

None.

Query Parameters

Parameter Default Description Required
limit 20 A limit on the number of objects to be returned, between 1 and 100. No
starting_after none A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. No
ending_before none A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. No

Accepts

None.

Returns

JSON A list array with a data property that contains an array of up to limit BillingPlans, starting after the specified starting_after BillingPlans (or ending before the specified ending_before BillingPlans). Each entry in the array is a full BillingPlans object. If no more BillingPlans are available, the resulting array will be empty. This request should never throw an error.

A list of BillingPlans objects matching the query. Also:

  • “total_count”: Integer count of the number of BillingPlans in the returned list.
  • “url”: The query string provided in the request
  • “next”: The route (partial URL) to the next BillingPlan object (string to select the “next”); included id should match that of the last object returned here
  • “previous”: The route (partial URL) to the previous BillingPlan object (string to select the “previous”); included id should match that of the first object returned here
  • cURL
  • Java
Example Request
curl -X GET \
-u acaff38d462f9430d5cbcbaf:a575771fc679b9de \
"https://api.prodtest.vindicia.com/billing_plans?limit=1"
        
The above command returns JSON structured like this:
{
    "object": "List",
    "data": [
        {
        "object": "BillingPlan",
        "id": "TESTPLAN0",
        "vid": "7835983e7d0608d36d4f40b01ab8843e011ab8d9",
        "created": "2013-04-15T10:21:43-07:00",
        "description": "TESTPLAN0 $0 Monthly",
        "status": "Active",
        "periods": {
            "object": "List",
            "data": [
                {
                "object": "BillingPlanPeriod",
                "type": "Month",
                "quantity": 1,
                "cycles": 0,
                "prices": {
                    "object": "List",
                    "data": [
                        {
                        "object": "BillingPlanPrice",
                        "amount": 0,
                        "currency": "USD"
                        }
                    ],
                    "total_count": 1
                    }
                }
            ],
            "total_count": 1
            },
        "metadata": {
            "plansource": "External",
            "plangroup": "April2013",
        },
        "billing_descriptor": "TESTPLAN0"
        }
    ],
    "total_count": 1,
    "url": "/billing_plans?limit=1",
    "next": "/billing_plans?limit=1&starting_after=TESTPLAN0",
    "previous": "/billing_plans?limit=1&ending_before=TESTPLAN0"
}
import com.vindicia.client.CashBox;
CashBox.apiKey = "acaff38d462f9430d5cbcbafa575771fc679b9de";
Map<string,> params = new HashMap<string,>();
params.put("limit",  1);
BillingPlan.list(params);
          
The above command returns JSON structured like this:
{
    "object": "List",
    "data": [
        {
        "object": "BillingPlan",
        "id": "TESTPLAN0",
        "vid": "7835983e7d0608d36d4f40b01ab8843e011ab8d9",
        "created": "2013-04-15T10:21:43-07:00",
        "description": "TESTPLAN0 $0 Monthly",
        "status": "Active",
        "periods": {
            "object": "List",
            "data": [
                {
                "object": "BillingPlanPeriod",
                "type": "Month",
                "quantity": 1,
                "cycles": 0,
                "prices": {
                    "object": "List",
                    "data": [
                        {
                        "object": "BillingPlanPrice",
                        "amount": 0,
                        "currency": "USD"
                        }
                    ],
                    "total_count": 1
                    }
                }
            ],
            "total_count": 1
            },
        "metadata": {
            "plansource": "External",
            "plangroup": "April2013",
        },
        "billing_descriptor": "TESTPLAN0"
        }
    ],
    "total_count": 1,
    "url": "/billing_plans?limit=1",
    "next": "/billing_plans?limit=1&starting_after=TESTPLAN0",
    "previous": "/billing_plans?limit=1&ending_before=TESTPLAN0"
}
          

For Users

Learn More
For Users

Cashbox Features

Learn More
Cashbox Features
Back to Top