List all Billing Plans

Retrieves all Billing Plans.

HTTP Request

GET https://api.vindicia.com/billing_plans

Route (URL) Parameters

None.

Query Parameters

Parameter	Default	Description	Required
limit	20	Allows for setting the max length of the returned array in the paginated results. Allowed values are between 1- 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
status	none	Use to filter list of Billing Plans by a status.	No
in_season	none	Datetime parameter that shows all the season sets that are in season on a specific day.	No
off_season	none	Datetime parameter that shows all the season sets that are not in season on a specific day.	No
entitlement	none	Use to filter the list of Billing Plans by a specific entitlement ID.	No

Accepts

None.

Returns

A JSON list object that contains an array of Billing Plan, starting after the specified starting_after Billing Plan (or ending before the specified ending_before Billing Plan). If no more Billing Plans are available, the resulting array will be empty. Additional list data included:

“total_count”: Integer count of the number of Billing Plans in the returned list.
“url”: The query string provided in the request
“next”: The route (partial URL) to the next Billing Plan 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 Billing Plan object (string to select the “previous”); included id should match that of the first object returned here

Example Request

curl -X GET \
-u acaff38d462f9430d5cbcbaf:a575771fc679b9de \
"https://api.staging.us-west.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"
}

Parent topic:Billing Plans

Home

Guides

APIs

HTTP Request

Route (URL) Parameters

Query Parameters

Accepts

Returns

Example Request

​HTTP Request

​Route (URL) Parameters

​Query Parameters

​Accepts

​Returns

​Example Request

HTTP Request

Route (URL) Parameters

Query Parameters

Accepts

Returns

Example Request