Skip to main content
Vindicia Knowledge Center

Fetch a specific BillingPlan

Fetch a specific BillingPlan

Retrieves a specific BillingPlan.

Route (URL) Parameters

Parameter Default Description Required
billingplan n/a The id or the vid of the BillingPlan to retrieve Yes

Query Parameters

None.

Accepts

None.

Returns

JSON A full BillingPlan object.

  • cURL
  • Java
Example Request
curl -X GET \
-u acaff38d462f9430d5cbcbaf:a575771fc679b9de \
"https://api.prodtest.vindicia.com/billing_plans/plan_1234"
          
The above command returns JSON structured like this:
{
    "object": "BillingPlan",
    "id": "plan_1234",
    "vid": "1d557e85e70a13140dcc9bd4fd18a02f63f09084",
    "created": "2016-05-27T14:42:08-07:00",
    "description": "Simple Monthly Billing Plan",
    "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
    },
    "end_of_life": "2099-12-31T00:00:00-08:00",
    "metadata": {
        "CatalogID": "plan1234"
        },
    "entitlements": {
        "object": "List",
        "data": [
            {
            "object": "Entitlement",
            "id": "plan_1234",
            "description": "plan_1234"
            }
        ],
        "total_count": 1
        }
}
          
import com.vindicia.client.CashBox;
CashBox.apiKey = "acaff38d462f9430d5cbcbaf:a575771fc679b9de";
BillingPlan.fetch("plan_1234");
          
The above command returns JSON structured like this:
{
    "object": "BillingPlan",
    "id": "plan_1234",
    "vid": "1d557e85e70a13140dcc9bd4fd18a02f63f09084",
    "created": "2016-05-27T14:42:08-07:00",
    "description": "Simple Monthly Billing Plan",
    "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
    },
    "end_of_life": "2099-12-31T00:00:00-08:00",
    "metadata": {
        "CatalogID": "plan1234"
        },
    "entitlements": {
        "object": "List",
        "data": [
            {
            "object": "Entitlement",
            "id": "plan_1234",
            "description": "plan_1234"
            }
        ],
        "total_count": 1
        }
}
          

For Users

Learn More
For Users

Cashbox Features

Learn More
Cashbox Features
Back to Top